priceRuleActivate mutation

Version unstable

Activate 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

ID of the price rule to update.

Return fields

  • priceRule (PriceRule)

    The activated price rule.

  • priceRuleUserErrors ([PriceRuleUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2021-10 (Release candidate)

Activate 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

ID of the price rule to update.

Return fields

  • priceRule (PriceRule)

    The activated price rule.

  • priceRuleUserErrors ([PriceRuleUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2021-07 (Latest)

Activate 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

ID of the price rule to update.

Return fields

  • priceRule (PriceRule)

    The activated price rule.

  • priceRuleUserErrors ([PriceRuleUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use priceRuleUserErrors instead

Version 2021-04

Activate 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

ID of the price rule to update.

Return fields

  • priceRule (PriceRule)

    The activated price rule.

  • priceRuleUserErrors ([PriceRuleUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.