priceRuleDeactivate

mutationDeprecated

Requires write_price_rules access scope.

Deactivate a price rule. Use discountCodeDeactivate instead.

Arguments

Anchor to idid • ID!required: ID of the price rule to update.

Was this section helpful?

Anchor to PriceRuleDeactivatePayload returnsPriceRuleDeactivatePayload returns

Anchor to priceRulepriceRule • PriceRule: The deactivated price rule.
Anchor to priceRuleUserErrorspriceRuleUserErrors • [PriceRuleUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to userErrorsuserErrors • [UserError!]!non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation priceRuleDeactivate($id: ID!) {
2  priceRuleDeactivate(id: $id) {
3    priceRule {
4      # PriceRule fields
5    }
6    priceRuleUserErrors {
7      # PriceRuleUserError fields
8    }
9    userErrors {
10      field
11      message
12    }
13  }
14}

Input

1{
2  "id": "gid://shopify/<objectName>/10079785100"
3}

{
  "id": "gid://shopify/<objectName>/10079785100"
}