We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

priceRuleDiscountCodeCreate

Version 2019-04

Create a discount code for a price rule.

Required access

write_price_rules access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

code ( String! ) required

The code to create for the price rule.

priceRuleId ( ID! ) required

The id of the price rule object

Return Fields

priceRule (PriceRule)

The updated price rule.

priceRuleDiscountCode (PriceRuleDiscountCode)

The newly created discount code.

priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead

Version 2019-07 (Latest)

Create a discount code for a price rule.

Required access

write_price_rules access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

code ( String! ) required

The code to create for the price rule.

priceRuleId ( ID! ) required

The id of the price rule object

Return Fields

priceRule (PriceRule)

The updated price rule.

priceRuleDiscountCode (PriceRuleDiscountCode)

The newly created discount code.

priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead

Version 2019-10 (Release candidate)

Create a discount code for a price rule.

Required access

write_price_rules access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

code ( String! ) required

The code to create for the price rule.

priceRuleId ( ID! ) required

The id of the price rule object

Return Fields

priceRule (PriceRule)

The updated price rule.

priceRuleDiscountCode (PriceRuleDiscountCode)

The newly created discount code.

priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead

Sign up for a Partner account to get started.

Sign up