giftCardDebit
mutation

Choose a version:

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

Debit a gift card.

Anchor to section titled 'Arguments'

Arguments

Anchor to debitInput debitInput GiftCardDebitInput! required: The input fields to debit a gift card.
Anchor to id id ID! required: The ID of the gift card to be debited.

Was this section helpful?

Anchor to section titled 'GiftCardDebitPayload returns'

GiftCardDebitPayload returns

Anchor to GiftCardDebitPayload.giftCardDebitTransaction giftCardDebitTransaction GiftCardDebitTransaction: The gift card debit transaction that was created.
Anchor to GiftCardDebitPayload.userErrors userErrors [GiftCardTransactionUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: giftCardDebit

Query Reference for MUTATION: giftCardDebit

"mutation giftCardDebit($debitInput: GiftCardDebitInput!, $id: ID!) {\n  giftCardDebit(debitInput: $debitInput, id: $id) {\n    giftCardDebitTransaction {\n      # GiftCardDebitTransaction fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: giftCardDebit

"{\n  \"debitInput\": {\n    \"debitAmount\": {\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: giftCardDebit

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

Display Examples for MUTATION: giftCardDebit

[]

giftCardDebitmutation

Arguments

GiftCardDebitPayload returns

giftCardDebit
mutation