checkoutGiftCardRemove mutation

Deprecation warning

Use checkoutGiftCardRemoveV2 instead

Removes an applied gift card from the checkout.

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
appliedGiftCardId ( ID! ) required

The ID of the Applied Gift Card to remove from the Checkout.

checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout!)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutGiftCardRemoveV2 instead

Removes an applied gift card from the checkout.

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
appliedGiftCardId ( ID! ) required

The ID of the Applied Gift Card to remove from the Checkout.

checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout!)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutGiftCardRemoveV2 instead

Removes an applied gift card from the checkout.

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
appliedGiftCardId ( ID! ) required

The ID of the Applied Gift Card to remove from the Checkout.

checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout!)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutGiftCardRemoveV2 instead

Removes an applied gift card from the checkout.

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
appliedGiftCardId ( ID! ) required

The ID of the Applied Gift Card to remove from the Checkout.

checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout!)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutGiftCardRemoveV2 instead

Removes an applied gift card from the checkout.

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
appliedGiftCardId ( ID! ) required

The ID of the Applied Gift Card to remove from the Checkout.

checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout!)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead

Deprecation warning

Use checkoutGiftCardRemoveV2 instead

Removes an applied gift card from the checkout.

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
appliedGiftCardId ( ID! ) required

The ID of the Applied Gift Card to remove from the Checkout.

checkoutId ( ID! ) required

The ID of the checkout.

Return fields

  • checkout (Checkout!)

    The updated checkout object.

  • checkoutUserErrors ([CheckoutUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead