giftCardDeactivate
mutation

Choose a version:

Requires write_gift_cards access scope. Also: User needs gift_cards permission.

Deactivate a gift card. A deactivated gift card cannot be used by a customer. A deactivated gift card cannot be re-enabled.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the gift card to deactivate.

Was this section helpful?

Anchor to section titled 'GiftCardDeactivatePayload returns'

GiftCardDeactivatePayload returns

Anchor to GiftCardDeactivatePayload.giftCard giftCard GiftCard: The deactivated gift card.
Anchor to GiftCardDeactivatePayload.userErrors userErrors [GiftCardDeactivateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: giftCardDeactivate

Query Reference for MUTATION: giftCardDeactivate

"mutation giftCardDeactivate($id: ID!) {\n  giftCardDeactivate(id: $id) {\n    giftCard {\n      # GiftCard fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: giftCardDeactivate

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

Schema Reference for MUTATION: giftCardDeactivate

""

Display Examples for MUTATION: giftCardDeactivate

[]

giftCardDeactivatemutation

Arguments

GiftCardDeactivatePayload returns

giftCardDeactivate
mutation