Choose a version:

giftCardUpdate

mutation

Requires write_gift_cards access scope.

Update a gift card.

Arguments

Anchor to idid •ID!required: The ID of the gift card to be updated.
Anchor to inputinput •GiftCardUpdateInput!required: The input fields to update the gift card.

Was this section helpful?

Anchor to GiftCardUpdatePayload returnsGiftCardUpdatePayload returns

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

Was this section helpful?

Update a gift card's customer
Update a gift card's expiration date so that it will never expire
Update a gift card's recipient
Update an existing gift card
giftCardUpdate reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {

giftCardUpdate(id: $id, input: $input) {

userErrors {

message

field

}

giftCard {

customer {

}

}`,

{

variables: {

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

"input": {

"customerId": "gid://shopify/Customer/331283560"

}

);

const data = await response.json();

mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
  giftCardUpdate(id: $id, input: $input) {
    userErrors {
      message
      field
    }
    giftCard {
      id
      customer {
        id
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) { giftCardUpdate(id: $id, input: $input) { userErrors { message field } giftCard { id customer { id } } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/63396415",
    "input": {
      "customerId": "gid://shopify/Customer/331283560"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
    giftCardUpdate(id: $id, input: $input) {
      userErrors {
        message
        field
      }
      giftCard {
        id
        customer {
          id
        }
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/GiftCard/63396415",
      "input": {
        "customerId": "gid://shopify/Customer/331283560"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
      giftCardUpdate(id: $id, input: $input) {
        userErrors {
          message
          field
        }
        giftCard {
          id
          customer {
            id
          }
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/GiftCard/63396415",
      "input": {
        "customerId": "gid://shopify/Customer/331283560"
      }
    },
  },
});

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 giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
    giftCardUpdate(id: $id, input: $input) {
      userErrors {
        message
        field
      }
      giftCard {
        id
        customer {
          id
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "customerId": "gid://shopify/Customer/331283560"
  }
}

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

Input variables

JSON

{

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

"input": {

"customerId": "gid://shopify/Customer/331283560"

}

Response

JSON

{

"giftCardUpdate": {

"userErrors": [],

"giftCard": {

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

"customer": {

"id": "gid://shopify/Customer/331283560"

}