priceRuleDiscountCodeUpdate mutation

This page was printed on Dec 12, 2019. For the current version, visit https://help.shopify.com/en/api/graphql-admin-api/reference/mutation/pricerulediscountcodeupdate.
Version 2020-01 (Release candidate)

Update 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 new code of a price rule.
priceRuleId ( ID! ) required

The id of the price rule object

Return fields

priceRule (PriceRule)

The updated price rule.
priceRuleDiscountCode (PriceRuleDiscountCode)

The updated 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 (Latest)

Update 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 new code of a price rule.
priceRuleId ( ID! ) required

The id of the price rule object

Return fields

priceRule (PriceRule)

The updated price rule.
priceRuleDiscountCode (PriceRuleDiscountCode)

The updated 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

Update 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 new code of a price rule.
priceRuleId ( ID! ) required

The id of the price rule object

Return fields

priceRule (PriceRule)

The updated price rule.
priceRuleDiscountCode (PriceRuleDiscountCode)

The updated 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-04

Update 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 new code of a price rule.
priceRuleId ( ID! ) required

The id of the price rule object

Return fields

priceRule (PriceRule)

The updated price rule.
priceRuleDiscountCode (PriceRuleDiscountCode)

The updated 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