discountRedeemCodeBulkAdd - admin-graphql - MUTATION

Version: 2024-10

Description:

Asynchronously add discount redeem codes in bulk. Specify the codes to add and the discount code ID that the codes will belong to.

Access Scopes

Apps must have `write_discounts` access scope.

Arguments

• codes: DiscountRedeemCodeInput! - The list of codes that will be added to the code discount. Maximum 100 codes permitted.
• discountId: ID! - The ID of the code discount that the codes will be added to.

Returns

• bulkCreation: DiscountRedeemCodeBulkCreation The ID of the discount redeem code bulk creation operation. The properties and status of the operation can be tracked using the [`DiscountRedeemCodeBulkCreation` query](https://shopify.dev/api/admin-graphql/2022-04/queries/discountRedeemCodeBulkCreation).
• userErrors: DiscountUserError! The list of errors that occurred from executing the mutation.

Examples

• Asynchronously add redeem codes to a code discount

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) { discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) { bulkCreation { id } userErrors { code field message } } }\",\n \"variables\": {\n    \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n    \"codes\": [\n      {\n        \"code\": \"DISCOUNT_1\"\n      },\n      {\n        \"code\": \"DISCOUNT_2\"\n      },\n      {\n        \"code\": \"DISCOUNT_3\"\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n      discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n        bulkCreation {\n          id\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n      \"codes\": [\n        {\n          \"code\": \"DISCOUNT_1\"\n        },\n        {\n          \"code\": \"DISCOUNT_2\"\n        },\n        {\n          \"code\": \"DISCOUNT_3\"\n        }\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n      bulkCreation {\n        id\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n  \"codes\": [{\"code\"=>\"DISCOUNT_1\"}, {\"code\"=>\"DISCOUNT_2\"}, {\"code\"=>\"DISCOUNT_3\"}]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/DiscountCodeNode/2429471\",\n  \"codes\" => [{\"code\"=>\"DISCOUNT_1\"}, {\"code\"=>\"DISCOUNT_2\"}, {\"code\"=>\"DISCOUNT_3\"}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n      bulkCreation {\n        id\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n      \"codes\": [\n        {\n          \"code\": \"DISCOUNT_1\"\n        },\n        {\n          \"code\": \"DISCOUNT_2\"\n        },\n        {\n          \"code\": \"DISCOUNT_3\"\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation discountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n  discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n    bulkCreation {\n      id\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "discountRedeemCodeBulkAdd": {
        "bulkCreation": {
          "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355207"
        },
        "userErrors": []
      }
    }
  }

  Creates a discount code

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) { discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) { bulkCreation { id createdAt discountCode { id } done codesCount importedCount failedCount } userErrors { code field message } } }\",\n \"variables\": {\n    \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n    \"codes\": [\n      {\n        \"code\": \"DISCOUNT_1\"\n      },\n      {\n        \"code\": \"DISCOUNT_2\"\n      },\n      {\n        \"code\": \"DISCOUNT_3\"\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n      discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n        bulkCreation {\n          id\n          createdAt\n          discountCode {\n            id\n          }\n          done\n          codesCount\n          importedCount\n          failedCount\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n      \"codes\": [\n        {\n          \"code\": \"DISCOUNT_1\"\n        },\n        {\n          \"code\": \"DISCOUNT_2\"\n        },\n        {\n          \"code\": \"DISCOUNT_3\"\n        }\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n      bulkCreation {\n        id\n        createdAt\n        discountCode {\n          id\n        }\n        done\n        codesCount\n        importedCount\n        failedCount\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n  \"codes\": [{\"code\"=>\"DISCOUNT_1\"}, {\"code\"=>\"DISCOUNT_2\"}, {\"code\"=>\"DISCOUNT_3\"}]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/DiscountCodeNode/2429471\",\n  \"codes\" => [{\"code\"=>\"DISCOUNT_1\"}, {\"code\"=>\"DISCOUNT_2\"}, {\"code\"=>\"DISCOUNT_3\"}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n      bulkCreation {\n        id\n        createdAt\n        discountCode {\n          id\n        }\n        done\n        codesCount\n        importedCount\n        failedCount\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n      \"codes\": [\n        {\n          \"code\": \"DISCOUNT_1\"\n        },\n        {\n          \"code\": \"DISCOUNT_2\"\n        },\n        {\n          \"code\": \"DISCOUNT_3\"\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n  discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n    bulkCreation {\n      id\n      createdAt\n      discountCode {\n        id\n      }\n      done\n      codesCount\n      importedCount\n      failedCount\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "discountRedeemCodeBulkAdd": {
        "bulkCreation": {
          "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355210",
          "createdAt": "2024-11-06T21:59:51Z",
          "discountCode": {
            "id": "gid://shopify/DiscountCodeNode/2429471"
          },
          "done": false,
          "codesCount": 3,
          "importedCount": 0,
          "failedCount": 0
        },
        "userErrors": []
      }
    }
  }

  Creates a discount code creation job

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) { discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) { bulkCreation { id createdAt discountCode { id } done codesCount importedCount failedCount } userErrors { code field message } } }\",\n \"variables\": {\n    \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n    \"codes\": [\n      {\n        \"code\": \"DISCOUNT_1\"\n      },\n      {\n        \"code\": \"DISCOUNT_2\"\n      },\n      {\n        \"code\": \"DISCOUNT_3\"\n      }\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n      discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n        bulkCreation {\n          id\n          createdAt\n          discountCode {\n            id\n          }\n          done\n          codesCount\n          importedCount\n          failedCount\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n      \"codes\": [\n        {\n          \"code\": \"DISCOUNT_1\"\n        },\n        {\n          \"code\": \"DISCOUNT_2\"\n        },\n        {\n          \"code\": \"DISCOUNT_3\"\n        }\n      ]\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n      bulkCreation {\n        id\n        createdAt\n        discountCode {\n          id\n        }\n        done\n        codesCount\n        importedCount\n        failedCount\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n  \"codes\": [{\"code\"=>\"DISCOUNT_1\"}, {\"code\"=>\"DISCOUNT_2\"}, {\"code\"=>\"DISCOUNT_3\"}]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/DiscountCodeNode/2429471\",\n  \"codes\" => [{\"code\"=>\"DISCOUNT_1\"}, {\"code\"=>\"DISCOUNT_2\"}, {\"code\"=>\"DISCOUNT_3\"}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n    discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n      bulkCreation {\n        id\n        createdAt\n        discountCode {\n          id\n        }\n        done\n        codesCount\n        importedCount\n        failedCount\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n      \"codes\": [\n        {\n          \"code\": \"DISCOUNT_1\"\n        },\n        {\n          \"code\": \"DISCOUNT_2\"\n        },\n        {\n          \"code\": \"DISCOUNT_3\"\n        }\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DiscountRedeemCodeBulkAdd($discountId: ID!, $codes: [DiscountRedeemCodeInput!]!) {\n  discountRedeemCodeBulkAdd(discountId: $discountId, codes: $codes) {\n    bulkCreation {\n      id\n      createdAt\n      discountCode {\n        id\n      }\n      done\n      codesCount\n      importedCount\n      failedCount\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "discountRedeemCodeBulkAdd": {
        "bulkCreation": {
          "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355209",
          "createdAt": "2024-11-06T21:59:51Z",
          "discountCode": {
            "id": "gid://shopify/DiscountCodeNode/2429471"
          },
          "done": false,
          "codesCount": 3,
          "importedCount": 0,
          "failedCount": 0
        },
        "userErrors": []
      }
    }
  }