Choose a version:

giftCardDeactivate

mutation

Requires write_gift_cards access scope.

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

Arguments

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

Was this section helpful?

Anchor to GiftCardDeactivatePayload returnsGiftCardDeactivatePayload returns

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

Was this section helpful?

Disables a gift card
giftCardDeactivate reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation giftCardDeactivate($id: ID!) {

giftCardDeactivate(id: $id) {

giftCard {

deactivatedAt

}

userErrors {

message

field

code

}

}`,

{

variables: {

"id": "gid://shopify/GiftCard/411106674"

);

const data = await response.json();

mutation giftCardDeactivate($id: ID!) {
  giftCardDeactivate(id: $id) {
    giftCard {
      id
      deactivatedAt
    }
    userErrors {
      message
      field
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation giftCardDeactivate($id: ID!) { giftCardDeactivate(id: $id) { giftCard { id deactivatedAt } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/411106674"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation giftCardDeactivate($id: ID!) {
    giftCardDeactivate(id: $id) {
      giftCard {
        id
        deactivatedAt
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/GiftCard/411106674"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation giftCardDeactivate($id: ID!) {
      giftCardDeactivate(id: $id) {
        giftCard {
          id
          deactivatedAt
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/GiftCard/411106674"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation giftCardDeactivate($id: ID!) {
    giftCardDeactivate(id: $id) {
      giftCard {
        id
        deactivatedAt
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/411106674"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/GiftCard/411106674"

}

Response

JSON

{

"giftCardDeactivate": {

"giftCard": {

"id": "gid://shopify/GiftCard/411106674",

"deactivatedAt": "2024-11-05T15:35:29Z"

"userErrors": []

}