priceRuleDiscountCodeCreate

mutationDeprecated

Requires write_price_rules access scope.

Create a discount code for a price rule. Use discountRedeemCodeBulkAdd instead.

Arguments

Anchor to codecode • String!required: The code to create for the price rule.
Anchor to priceRuleIdpriceRuleId • ID!required: The ID of the price rule object.

Was this section helpful?

Anchor to PriceRuleDiscountCodeCreatePayload returnsPriceRuleDiscountCodeCreatePayload returns

Anchor to priceRulepriceRule • PriceRule: The updated price rule.
Anchor to priceRuleDiscountCodepriceRuleDiscountCode • PriceRuleDiscountCode: The newly created discount code.
Anchor to priceRuleUserErrorspriceRuleUserErrors • [PriceRuleUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to userErrorsuserErrors • [UserError!]!non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a discount code for a price rule
priceRuleDiscountCodeCreate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation priceRuleDiscountCodeCreate($priceRuleId: ID!, $code: String!) {
6    priceRuleDiscountCodeCreate(priceRuleId: $priceRuleId, code: $code) {
7      priceRuleUserErrors {
8        field
9        message
10        code
11      }
12      priceRule {
13        id
14        title
15      }
16      priceRuleDiscountCode {
17        code
18      }
19    }
20  }`,
21  {
22    variables: {
23      "priceRuleId": "gid://shopify/PriceRule/1057371202",
24      "code": "SOCKDISCOUNT"
25    },
26  },
27);
28
29const data = await response.json();
30

mutation priceRuleDiscountCodeCreate($priceRuleId: ID!, $code: String!) {
  priceRuleDiscountCodeCreate(priceRuleId: $priceRuleId, code: $code) {
    priceRuleUserErrors {
      field
      message
      code
    }
    priceRule {
      id
      title
    }
    priceRuleDiscountCode {
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation priceRuleDiscountCodeCreate($priceRuleId: ID!, $code: String!) { priceRuleDiscountCodeCreate(priceRuleId: $priceRuleId, code: $code) { priceRuleUserErrors { field message code } priceRule { id title } priceRuleDiscountCode { code } } }",
 "variables": {
    "priceRuleId": "gid://shopify/PriceRule/1057371202",
    "code": "SOCKDISCOUNT"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation priceRuleDiscountCodeCreate($priceRuleId: ID!, $code: String!) {
    priceRuleDiscountCodeCreate(priceRuleId: $priceRuleId, code: $code) {
      priceRuleUserErrors {
        field
        message
        code
      }
      priceRule {
        id
        title
      }
      priceRuleDiscountCode {
        code
      }
    }
  }`,
  {
    variables: {
      "priceRuleId": "gid://shopify/PriceRule/1057371202",
      "code": "SOCKDISCOUNT"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation priceRuleDiscountCodeCreate($priceRuleId: ID!, $code: String!) {
      priceRuleDiscountCodeCreate(priceRuleId: $priceRuleId, code: $code) {
        priceRuleUserErrors {
          field
          message
          code
        }
        priceRule {
          id
          title
        }
        priceRuleDiscountCode {
          code
        }
      }
    }`,
    "variables": {
      "priceRuleId": "gid://shopify/PriceRule/1057371202",
      "code": "SOCKDISCOUNT"
    },
  },
});

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 priceRuleDiscountCodeCreate($priceRuleId: ID!, $code: String!) {
    priceRuleDiscountCodeCreate(priceRuleId: $priceRuleId, code: $code) {
      priceRuleUserErrors {
        field
        message
        code
      }
      priceRule {
        id
        title
      }
      priceRuleDiscountCode {
        code
      }
    }
  }
QUERY

variables = {
  "priceRuleId": "gid://shopify/PriceRule/1057371202",
  "code": "SOCKDISCOUNT"
}

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

Input variables

JSON

1{
2  "priceRuleId": "gid://shopify/PriceRule/1057371202",
3  "code": "SOCKDISCOUNT"
4}

Response

JSON

1{
2  "priceRuleDiscountCodeCreate": {
3    "priceRuleUserErrors": [],
4    "priceRule": {
5      "id": "gid://shopify/PriceRule/1057371202",
6      "title": "PROTABO"
7    },
8    "priceRuleDiscountCode": {
9      "code": "SOCKDISCOUNT"
10    }
11  }
12}