Choose a version:

giftCardUpdate

mutation

Requires write_gift_cards access scope.

Update a gift card.

Anchor to Arguments

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?

Examples

Update a gift card's customer

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"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--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"
  }
}'

Response

{
  "giftCardUpdate": {
    "userErrors": [],
    "giftCard": {
      "id": "gid://shopify/GiftCard/63396415",
      "customer": {
        "id": "gid://shopify/Customer/331283560"
      }
    }
  }
}

Update a gift card's expiration date so that it will never expire

Query

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

Variables

{
  "id": "gid://shopify/GiftCard/746346263",
  "input": {
    "expiresOn": null
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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 expiresOn } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/746346263",
    "input": {
      "expiresOn": null
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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
        expiresOn
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/746346263",
        "input": {
            "expiresOn": null
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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
        expiresOn
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/746346263",
  "input": {
    "expiresOn": null
  }
}

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

Node.js

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
          expiresOn
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/746346263",
        "input": {
            "expiresOn": null
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
  giftCardUpdate(id: $id, input: $input) {
    userErrors {
      message
      field
    }
    giftCard {
      id
      expiresOn
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/746346263",
  "input": {
    "expiresOn": null
  }
}'

Response

{
  "giftCardUpdate": {
    "userErrors": [],
    "giftCard": {
      "id": "gid://shopify/GiftCard/746346263",
      "expiresOn": null
    }
  }
}

Update a gift card's notify status

Query

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

Variables

{
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "notify": false
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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) { giftCard { id notify } userErrors { message field } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/63396415",
    "input": {
      "notify": false
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation GiftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
    giftCardUpdate(id: $id, input: $input) {
      giftCard {
        id
        notify
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/63396415",
        "input": {
            "notify": false
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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) {
      giftCard {
        id
        notify
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "notify": false
  }
}

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

Node.js

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) {
        giftCard {
          id
          notify
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/63396415",
        "input": {
            "notify": false
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation GiftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
  giftCardUpdate(id: $id, input: $input) {
    giftCard {
      id
      notify
    }
    userErrors {
      message
      field
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "notify": false
  }
}'

Response

{
  "giftCardUpdate": {
    "giftCard": {
      "id": "gid://shopify/GiftCard/63396415",
      "notify": false
    },
    "userErrors": []
  }
}

Update a gift card's recipient

Query

mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
  giftCardUpdate(id: $id, input: $input) {
    giftCard {
      id
      recipientAttributes {
        recipient {
          id
        }
        message
        preferredName
        sendNotificationAt
      }
    }
    userErrors {
      message
      field
    }
  }
}

Variables

{
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "recipientAttributes": {
      "id": "gid://shopify/Customer/331283560",
      "message": "Happy Birthday!",
      "preferredName": "Dad",
      "sendNotificationAt": "2024-10-01T11:00:00Z"
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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) { giftCard { id recipientAttributes { recipient { id } message preferredName sendNotificationAt } } userErrors { message field } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/63396415",
    "input": {
      "recipientAttributes": {
        "id": "gid://shopify/Customer/331283560",
        "message": "Happy Birthday!",
        "preferredName": "Dad",
        "sendNotificationAt": "2024-10-01T11:00:00Z"
      }
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
    giftCardUpdate(id: $id, input: $input) {
      giftCard {
        id
        recipientAttributes {
          recipient {
            id
          }
          message
          preferredName
          sendNotificationAt
        }
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/63396415",
        "input": {
            "recipientAttributes": {
                "id": "gid://shopify/Customer/331283560",
                "message": "Happy Birthday!",
                "preferredName": "Dad",
                "sendNotificationAt": "2024-10-01T11:00:00Z"
            }
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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) {
      giftCard {
        id
        recipientAttributes {
          recipient {
            id
          }
          message
          preferredName
          sendNotificationAt
        }
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "recipientAttributes": {
      "id": "gid://shopify/Customer/331283560",
      "message": "Happy Birthday!",
      "preferredName": "Dad",
      "sendNotificationAt": "2024-10-01T11:00:00Z"
    }
  }
}

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

Node.js

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) {
        giftCard {
          id
          recipientAttributes {
            recipient {
              id
            }
            message
            preferredName
            sendNotificationAt
          }
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/63396415",
        "input": {
            "recipientAttributes": {
                "id": "gid://shopify/Customer/331283560",
                "message": "Happy Birthday!",
                "preferredName": "Dad",
                "sendNotificationAt": "2024-10-01T11:00:00Z"
            }
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation giftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
  giftCardUpdate(id: $id, input: $input) {
    giftCard {
      id
      recipientAttributes {
        recipient {
          id
        }
        message
        preferredName
        sendNotificationAt
      }
    }
    userErrors {
      message
      field
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "recipientAttributes": {
      "id": "gid://shopify/Customer/331283560",
      "message": "Happy Birthday!",
      "preferredName": "Dad",
      "sendNotificationAt": "2024-10-01T11:00:00Z"
    }
  }
}'

Response

{
  "giftCardUpdate": {
    "giftCard": {
      "id": "gid://shopify/GiftCard/63396415",
      "recipientAttributes": {
        "recipient": {
          "id": "gid://shopify/Customer/331283560"
        },
        "message": "Happy Birthday!",
        "preferredName": "Dad",
        "sendNotificationAt": "2024-10-01T11:00:00Z"
      }
    },
    "userErrors": []
  }
}

Update an existing gift card

Query

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

Variables

{
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "note": "A note."
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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) { giftCard { id note } userErrors { message field } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/63396415",
    "input": {
      "note": "A note."
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation GiftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
    giftCardUpdate(id: $id, input: $input) {
      giftCard {
        id
        note
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/63396415",
        "input": {
            "note": "A note."
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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) {
      giftCard {
        id
        note
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "note": "A note."
  }
}

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

Node.js

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) {
        giftCard {
          id
          note
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/63396415",
        "input": {
            "note": "A note."
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation GiftCardUpdate($id: ID!, $input: GiftCardUpdateInput!) {
  giftCardUpdate(id: $id, input: $input) {
    giftCard {
      id
      note
    }
    userErrors {
      message
      field
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "note": "A note."
  }
}'

Response

{
  "giftCardUpdate": {
    "giftCard": {
      "id": "gid://shopify/GiftCard/63396415",
      "note": "A note."
    },
    "userErrors": []
  }
}

giftCardUpdate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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 json = await response.json();

return json.data;

}

GQL

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Node.js

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"
        }
    },
  },
});

Ruby

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)

Shopify CLI

shopify app execute \
--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"
  }
}'

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"

}