Choose a version:

discountRedeemCodeBulkAdd

mutation

Requires Apps must have write_discounts access scope.

Asynchronously add discount codes in bulk that customers can use to redeem a discount. You can use the discountRedeemCodeBulkAdd mutation to automate the distribution of discount codes through emails or other marketing channels.

Arguments

Anchor to codescodes • [DiscountRedeemCodeInput!]!required: The list of codes to associate with the code discount. Maximum: 100 codes.
Anchor to discountIddiscountId • ID!required: The ID of the DiscountCodeNode object that the codes will be added to. For example, gid://shopify/DiscountCodeNode/123. You can use the codeDiscountNodes query to retrieve the ID.

Was this section helpful?

Anchor to DiscountRedeemCodeBulkAddPayload returnsDiscountRedeemCodeBulkAddPayload returns

Anchor to bulkCreationbulkCreation • DiscountRedeemCodeBulkCreation: The ID of bulk operation that creates multiple unique discount codes. You can use the discountRedeemCodeBulkCreation query to track the status of the bulk operation.
Anchor to userErrorsuserErrors • [DiscountUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Asynchronously add redeem codes to a code discount
Creates a discount code
Creates a discount code creation job
discountRedeemCodeBulkAdd reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {

discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {

bulkCreation {

}

userErrors {

code

field

message

}

}`,

{

variables: {

"discountId": "gid://shopify/DiscountCodeNode/2429471",

"codes": [

{

"code": "DISCOUNT_1"

{

"code": "DISCOUNT_2"

{

"code": "DISCOUNT_3"

}

]

);

const data = await response.json();

mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {
  discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {
    bulkCreation {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) { discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) { bulkCreation { id } userErrors { code field message } } }",
 "variables": {
    "discountId": "gid://shopify/DiscountCodeNode/2429471",
    "codes": [
      {
        "code": "DISCOUNT_1"
      },
      {
        "code": "DISCOUNT_2"
      },
      {
        "code": "DISCOUNT_3"
      }
    ]
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {
    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {
      bulkCreation {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "discountId": "gid://shopify/DiscountCodeNode/2429471",
      "codes": [
        {
          "code": "DISCOUNT_1"
        },
        {
          "code": "DISCOUNT_2"
        },
        {
          "code": "DISCOUNT_3"
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {
      discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {
        bulkCreation {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "discountId": "gid://shopify/DiscountCodeNode/2429471",
      "codes": [
        {
          "code": "DISCOUNT_1"
        },
        {
          "code": "DISCOUNT_2"
        },
        {
          "code": "DISCOUNT_3"
        }
      ]
    },
  },
});

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 discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {
    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {
      bulkCreation {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "discountId": "gid://shopify/DiscountCodeNode/2429471",
  "codes": [{"code"=>"DISCOUNT_1"}, {"code"=>"DISCOUNT_2"}, {"code"=>"DISCOUNT_3"}]
}

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

Input variables

JSON

{

"discountId": "gid://shopify/DiscountCodeNode/2429471",

"codes": [

{

"code": "DISCOUNT_1"

{

"code": "DISCOUNT_2"

{

"code": "DISCOUNT_3"

}

]

}

Response

JSON

{

"discountRedeemCodeBulkAdd": {

"bulkCreation": {

"id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355207"

"userErrors": []

}