priceRuleDelete mutation

Version 2020-01 (Release candidate)

Delete 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

id ( ID! ) required

The id of the price rule object.

Return fields

deletedPriceRuleId (ID)

The id price of the deleted price rule.

priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

shop (Shop!)

The shop of the deleted price rule.

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)

Delete 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

id ( ID! ) required

The id of the price rule object.

Return fields

deletedPriceRuleId (ID)

The id price of the deleted price rule.

priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

shop (Shop!)

The shop of the deleted price rule.

Deprecated return fields

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

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead

Version 2019-07

Delete 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

id ( ID! ) required

The id of the price rule object.

Return fields

deletedPriceRuleId (ID)

The id price of the deleted price rule.

priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

shop (Shop!)

The shop of the deleted price rule.

Deprecated return fields

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

List of errors that occurred executing the mutation.

Deprecation warning

Use priceRuleUserErrors instead

Version 2019-04

Delete 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

id ( ID! ) required

The id of the price rule object.

Return fields

deletedPriceRuleId (ID)

The id price of the deleted price rule.

priceRuleUserErrors ([PriceRuleUserError!]!)

List of errors that occurred executing the mutation.

shop (Shop!)

The shop of the deleted price rule.

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