discountCodeDeactivate mutation

Deactivates a code discount.

Required access

Apps must have write_discounts access scope.

On this page

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.

mutation discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { 
  1. <font style="color:#1F61A0;">codeDiscountNode</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">code</font>
  11.   <font style="color:#1F61A0;">extraInfo</font>
  13.   <font style="color:#1F61A0;">field</font>
  15.   <font style="color:#1F61A0;">message</font>
  17. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the code discount to deactivate.

Return fields

  • codeDiscountNode ([DiscountCodeNode](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodenode))
    The deactivated code discount.
  • userErrors ([[DiscountUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountusererror))
    List of errors that occurred executing the mutation.