giftCardCredit
mutation

Choose a version:

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

Credit a gift card.

Anchor to section titled 'Arguments'

Arguments

Anchor to creditInput creditInput GiftCardCreditInput! required: The input fields to credit a gift card.
Anchor to id id ID! required: The ID of the gift card to be credited.

Was this section helpful?

Anchor to section titled 'GiftCardCreditPayload returns'

GiftCardCreditPayload returns

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

Was this section helpful?

Code examples for MUTATION: giftCardCredit

Query Reference for MUTATION: giftCardCredit

"mutation giftCardCredit($creditInput: GiftCardCreditInput!, $id: ID!) {\n  giftCardCredit(creditInput: $creditInput, id: $id) {\n    giftCardCreditTransaction {\n      # GiftCardCreditTransaction fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: giftCardCredit

"{\n  \"creditInput\": {\n    \"creditAmount\": {\n      \"amount\": \"29.99\",\n      \"currencyCode\": \"AED\"\n    },\n    \"note\": \"<your-note>\",\n    \"processedAt\": \"2019-09-07T15:50:00Z\"\n  },\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: giftCardCredit

"input GiftCardCreditInput {\n  creditAmount: MoneyInput!\n  note: String\n  processedAt: DateTime\n}\n\ninput MoneyInput {\n  amount: Decimal!\n  currencyCode: CurrencyCode!\n}\n"

Display Examples for MUTATION: giftCardCredit

[]

giftCardCreditmutation

Arguments

GiftCardCreditPayload returns

giftCardCredit
mutation