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

Update a gift card.


Anchor to id
id
required

The ID of the gift card to be updated.

The input fields to update the gift card.


Was this section helpful?

The updated gift card.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
Copy
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-01/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();
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)
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"
      }
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "id": "gid://shopify/GiftCard/63396415",
  "input": {
    "customerId": "gid://shopify/Customer/331283560"
  }
}
Hide code
Response
JSON
{
  "giftCardUpdate": {
    "userErrors": [],
    "giftCard": {
      "id": "gid://shopify/GiftCard/63396415",
      "customer": {
        "id": "gid://shopify/Customer/331283560"
      }
    }
  }
}