Choose a version:

discountCodeBxgyUpdate

mutation

Requires Apps must have write_discounts access scope.

Updates a buy X get Y discount (BXGY) that's applied on a cart and at checkout when a customer enters a code.

Note

To update discounts that are automatically applied on a cart and at checkout, use the discountAutomaticBxgyUpdate mutation.

Arguments

Anchor to bxgyCodeDiscountbxgyCodeDiscount •DiscountCodeBxgyInput!required: The input data used to update the BXGY code discount.
Anchor to idid •ID!required: The ID of the BXGY code discount to update.

Was this section helpful?

Anchor to DiscountCodeBxgyUpdatePayload returnsDiscountCodeBxgyUpdatePayload returns

Anchor to codeDiscountNodecodeDiscountNode •DiscountCodeNode: The code discount that was updated.
Anchor to userErrorsuserErrors •[DiscountUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Update an existing BXGY code discount's expiration date
Update an existing BXGY discount code's product variants, quantities, and percentages
discountCodeBxgyUpdate reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation discountCodeBxgyUpdate($id: ID!, $bxgyCodeDiscount: DiscountCodeBxgyInput!) {

discountCodeBxgyUpdate(id: $id, bxgyCodeDiscount: $bxgyCodeDiscount) {

codeDiscountNode {

codeDiscount {

... on DiscountCodeBxgy {

title

codes(first: 10) {

nodes {

code

}

endsAt

}

userErrors {

field

code

message

}

}`,

{

variables: {

"id": "gid://shopify/DiscountCodeNode/732991387",

"bxgyCodeDiscount": {

"endsAt": "2022-12-25T00:00:00Z"

}

);

const data = await response.json();

mutation discountCodeBxgyUpdate($id: ID!, $bxgyCodeDiscount: DiscountCodeBxgyInput!) {
  discountCodeBxgyUpdate(id: $id, bxgyCodeDiscount: $bxgyCodeDiscount) {
    codeDiscountNode {
      codeDiscount {
        ... on DiscountCodeBxgy {
          title
          codes(first: 10) {
            nodes {
              code
            }
          }
          endsAt
        }
      }
    }
    userErrors {
      field
      code
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountCodeBxgyUpdate($id: ID!, $bxgyCodeDiscount: DiscountCodeBxgyInput!) { discountCodeBxgyUpdate(id: $id, bxgyCodeDiscount: $bxgyCodeDiscount) { codeDiscountNode { codeDiscount { ... on DiscountCodeBxgy { title codes(first: 10) { nodes { code } } endsAt } } } userErrors { field code message } } }",
 "variables": {
    "id": "gid://shopify/DiscountCodeNode/732991387",
    "bxgyCodeDiscount": {
      "endsAt": "2022-12-25T00:00:00Z"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation discountCodeBxgyUpdate($id: ID!, $bxgyCodeDiscount: DiscountCodeBxgyInput!) {
    discountCodeBxgyUpdate(id: $id, bxgyCodeDiscount: $bxgyCodeDiscount) {
      codeDiscountNode {
        codeDiscount {
          ... on DiscountCodeBxgy {
            title
            codes(first: 10) {
              nodes {
                code
              }
            }
            endsAt
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/DiscountCodeNode/732991387",
      "bxgyCodeDiscount": {
        "endsAt": "2022-12-25T00:00:00Z"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeBxgyUpdate($id: ID!, $bxgyCodeDiscount: DiscountCodeBxgyInput!) {
      discountCodeBxgyUpdate(id: $id, bxgyCodeDiscount: $bxgyCodeDiscount) {
        codeDiscountNode {
          codeDiscount {
            ... on DiscountCodeBxgy {
              title
              codes(first: 10) {
                nodes {
                  code
                }
              }
              endsAt
            }
          }
        }
        userErrors {
          field
          code
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DiscountCodeNode/732991387",
      "bxgyCodeDiscount": {
        "endsAt": "2022-12-25T00:00:00Z"
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation discountCodeBxgyUpdate($id: ID!, $bxgyCodeDiscount: DiscountCodeBxgyInput!) {
    discountCodeBxgyUpdate(id: $id, bxgyCodeDiscount: $bxgyCodeDiscount) {
      codeDiscountNode {
        codeDiscount {
          ... on DiscountCodeBxgy {
            title
            codes(first: 10) {
              nodes {
                code
              }
            }
            endsAt
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountCodeNode/732991387",
  "bxgyCodeDiscount": {
    "endsAt": "2022-12-25T00:00:00Z"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/DiscountCodeNode/732991387",

"bxgyCodeDiscount": {

"endsAt": "2022-12-25T00:00:00Z"

}

Response

JSON

{

"discountCodeBxgyUpdate": {

"codeDiscountNode": {

"codeDiscount": {

"title": "simple_bogo",

"codes": {

"nodes": [

{

"code": "BOGO"

}

]

"endsAt": "2022-12-25T00:00:00Z"

}

"userErrors": []

}