giftCardCredit

mutation

Requires write_gift_card_transactions access scope.

Credit a gift card.

Arguments

Anchor to creditInputcreditInput • GiftCardCreditInput!required: The input fields to credit a gift card.
Anchor to idid • ID!required: The ID of the gift card to be credited.

Was this section helpful?

Anchor to GiftCardCreditPayload returnsGiftCardCreditPayload returns

Anchor to giftCardCreditTransactiongiftCardCreditTransaction • GiftCardCreditTransaction: The gift card credit transaction that was created.
Anchor to userErrorsuserErrors • [GiftCardTransactionUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a new Gift Card Adjustment
giftCardCredit reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
6    giftCardCredit(id: $id, creditInput: $creditInput) {
7      giftCardCreditTransaction {
8        id
9        amount {
10          amount
11          currencyCode
12        }
13        processedAt
14        note
15        giftCard {
16          id
17          balance {
18            amount
19            currencyCode
20          }
21        }
22      }
23      userErrors {
24        message
25        field
26        code
27      }
28    }
29  }`,
30  {
31    variables: {
32      "id": "gid://shopify/GiftCard/411106674",
33      "creditInput": {
34        "creditAmount": {
35          "amount": "10",
36          "currencyCode": "USD"
37        },
38        "processedAt": "2024-09-09T12:48:33-04:00",
39        "note": "A note."
40      }
41    },
42  },
43);
44
45const data = await response.json();
46

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/unstable/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

1{
2  "id": "gid://shopify/GiftCard/411106674",
3  "creditInput": {
4    "creditAmount": {
5      "amount": "10",
6      "currencyCode": "USD"
7    },
8    "processedAt": "2024-09-09T12:48:33-04:00",
9    "note": "A note."
10  }
11}

Response

JSON

1{
2  "giftCardCredit": {
3    "giftCardCreditTransaction": {
4      "id": "gid://shopify/GiftCardCreditTransaction/1064273912",
5      "amount": {
6        "amount": "10.0",
7        "currencyCode": "USD"
8      },
9      "processedAt": "2024-09-09T16:48:33Z",
10      "note": "A note.",
11      "giftCard": {
12        "id": "gid://shopify/GiftCard/411106674",
13        "balance": {
14          "amount": "35.0",
15          "currencyCode": "USD"
16        }
17      }
18    },
19    "userErrors": []
20  }
21}