Anchor to giftCardCreditgift
giftCardCredit
mutation
Requires access scope.
Credit a gift card.
Anchor to Arguments
Arguments
- Anchor to creditInputcredit•
Input GiftCard requiredCredit Input! The input fields to credit a gift card.
- •ID!required
The ID of the gift card to be credited.
Was this section helpful?
Anchor to GiftCardCreditPayload returnsGiftCardCreditPayload returns
- Anchor to giftCardCreditTransactiongift•
Card Credit Transaction The gift card credit transaction that was created.
- Anchor to userErrorsuser•
Errors [GiftCard non-nullTransaction User Error!]! The list of errors that occurred from executing the mutation.
Was this section helpful?
- Create a new Gift Card Adjustment
- giftCardCredit reference
Examples
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
giftCardCredit(id: $id, creditInput: $creditInput) {
giftCardCreditTransaction {
id
amount {
amount
currencyCode
}
processedAt
note
giftCard {
id
balance {
amount
currencyCode
}
}
}
userErrors {
message
field
code
}
}
}`,
{
variables: {
mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
giftCardCredit(id: $id, creditInput: $creditInput) {
giftCardCreditTransaction {
id
amount {
amount
currencyCode
}
processedAt
note
giftCard {
id
balance {
amount
currencyCode
}
}
}
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 giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) { giftCardCredit(id: $id, creditInput: $creditInput) { giftCardCreditTransaction { id amount { amount currencyCode } processedAt note giftCard { id balance { amount currencyCode } } } userErrors { message field code } } }",
"variables": {
"id": "gid://shopify/GiftCard/411106674",
"creditInput": {
"creditAmount": {
"amount": "10",
"currencyCode": "USD"
},
"processedAt": "2024-09-09T12:48:33-04:00",
"note": "A note."
}
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
giftCardCredit(id: $id, creditInput: $creditInput) {
giftCardCreditTransaction {
id
amount {
amount
currencyCode
}
processedAt
note
giftCard {
id
balance {
amount
currencyCode
}
}
}
userErrors {
message
field
code
}
}
}`,
{
variables: {
"id": "gid://shopify/GiftCard/411106674",
"creditInput": {
"creditAmount": {
"amount": "10",
"currencyCode": "USD"
},
"processedAt": "2024-09-09T12:48:33-04:00",
"note": "A note."
}
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
giftCardCredit(id: $id, creditInput: $creditInput) {
giftCardCreditTransaction {
id
amount {
amount
currencyCode
}
processedAt
note
giftCard {
id
balance {
amount
currencyCode
}
}
}
userErrors {
message
field
code
}
}
}`,
"variables": {
"id": "gid://shopify/GiftCard/411106674",
"creditInput": {
"creditAmount": {
"amount": "10",
"currencyCode": "USD"
},
"processedAt": "2024-09-09T12:48:33-04:00",
"note": "A note."
}
},
},
});
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 giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
giftCardCredit(id: $id, creditInput: $creditInput) {
giftCardCreditTransaction {
id
amount {
amount
currencyCode
}
processedAt
note
giftCard {
id
balance {
amount
currencyCode
}
}
}
userErrors {
message
field
code
}
}
}
QUERY
variables = {
"id": "gid://shopify/GiftCard/411106674",
"creditInput": {
"creditAmount": {
"amount": "10",
"currencyCode": "USD"
},
"processedAt": "2024-09-09T12:48:33-04:00",
"note": "A note."
}
}
response = client.query(query: query, variables: variables)
Input variables
JSON{
"id": "gid://shopify/GiftCard/411106674",
"creditInput": {
"creditAmount": {
"amount": "10",
"currencyCode": "USD"
},
"processedAt": "2024-09-09T12:48:33-04:00",
"note": "A note."
}
}
Response
JSON{
"giftCardCredit": {
"giftCardCreditTransaction": {
"id": "gid://shopify/GiftCardCreditTransaction/1064273912",
"amount": {
"amount": "10.0",
"currencyCode": "USD"
},
"processedAt": "2024-09-09T16:48:33Z",
"note": "A note.",
"giftCard": {
"id": "gid://shopify/GiftCard/411106674",
"balance": {
"amount": "35.0",
"currencyCode": "USD"
}
}
},
"userErrors": []
}
}