Skip to main content

checkoutRemovePromoCode Mutation

Remove a gift card or a voucher from a checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.
checkoutRemovePromoCode(
checkoutId: ID
id: ID
promoCode: String
promoCodeId: ID
token: UUID
): CheckoutRemovePromoCode

Arguments

checkoutRemovePromoCode.checkoutId ● ID deprecated scalar miscellaneous

DEPRECATED

Use id instead.

The ID of the checkout.

checkoutRemovePromoCode.id ● ID scalar miscellaneous

The checkout's ID.

checkoutRemovePromoCode.promoCode ● String scalar miscellaneous

Gift card code or voucher code.

checkoutRemovePromoCode.promoCodeId ● ID scalar miscellaneous

Gift card or voucher ID.

checkoutRemovePromoCode.token ● UUID deprecated scalar miscellaneous

DEPRECATED

Use id instead.

Checkout token.

Type

CheckoutRemovePromoCode object checkout

Remove a gift card or a voucher from a checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.