Anchor to section titled 'undefined'

priceRuleDiscountCodeCreate
mutation
deprecated

Requires write_price_rules access scope.

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


The code to create for the price rule.

Anchor to priceRuleId
priceRuleId
required

The ID of the price rule object.


Was this section helpful?

The updated price rule.

The newly created discount code.

The list of errors that occurred from executing the mutation.

The list of errors that occurred from executing the mutation. Use priceRuleUserErrors instead.


Was this section helpful?

Examples

Hide code
Copy
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-01/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();
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)
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"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "priceRuleId": "gid://shopify/PriceRule/1057371202",
  "code": "SOCKDISCOUNT"
}
Hide code
Response
JSON
{
  "priceRuleDiscountCodeCreate": {
    "priceRuleUserErrors": [],
    "priceRule": {
      "id": "gid://shopify/PriceRule/1057371202",
      "title": "PROTABO"
    },
    "priceRuleDiscountCode": {
      "code": "SOCKDISCOUNT"
    }
  }
}