Skip to main content

A type that defines the fields for the coupon information.

Note: This container is not returned for the getGuestPurchaseOrder method.

Type that uses Coupon

GuestCheckoutSessionResponseV2

Calls that use Coupon

POST
/guest_checkout_session/{checkoutSessionId}/apply_coupon
GET
/guest_checkout_session/{checkoutSessionId}
POST
/guest_checkout_session/initiate
POST
/guest_checkout_session/{checkoutSessionId}/remove_coupon
POST
/guest_checkout_session/{checkoutSessionId}/update_quantity
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_address
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_option

Fields

Field
Type
Description
redemptionCode
string
The coupon redemption code.