giftCardDisable mutation

Version unstable

Disable a gift card.

Required access

write_gift_cards access scope. Also: The API client must be a private or custom app installed on a Shopify Plus store.

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 gift card to disable.

Return fields

  • giftCard (GiftCard)

    The disabled gift card.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Disable a gift card.

Required access

write_gift_cards access scope. Also: The API client must be a private or custom app installed on a Shopify Plus store.

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 gift card to disable.

Return fields

  • giftCard (GiftCard)

    The disabled gift card.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-07 (Latest)

Disable a gift card.

Required access

write_gift_cards access scope. Also: The API client must be a private or custom app installed on a Shopify Plus store.

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 gift card to disable.

Return fields