Skip to main content
POST
Apply a coupon or gift card to the user's cart

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
coupon
string
required

The code for the coupon or gift card to apply.

Maximum string length: 40

Response

Successfully applied the coupon or gift card.

success
boolean

Indicates if the coupon or gift card was successfully applied.

message
string

A message indicating the result of applying the coupon or gift card.

percent
number<float>

Discount percentage if a coupon was applied.

amount
number<float>

Discount amount if a coupon was applied.

sum
number<float>

The amount of the gift card used.

type
string

The type of the applied code, either 'coupon' or 'gift'.