checkoutGiftCardApply mutation

Deprecation warning

Use checkoutGiftCardsAppend instead

Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards.

Required access

unauthenticated_write_checkouts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.

giftCardCode ( String! ) required

The code of the gift card to apply on the checkout.

Return fields

  • checkout (Checkout!)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutGiftCardsAppend instead

Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards.

Required access

unauthenticated_write_checkouts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
checkoutId ( ID! ) required

The ID of the checkout.

giftCardCode ( String! ) required