API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

priceRuleDelete mutation

Version unstable

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2021-04 (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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2021-01 (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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2020-10

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2020-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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2020-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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2020-01 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2019-10 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2019-07 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2019-04 (Unsupported)

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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead