Sign in
Baskets

Apply a coupon to a Basket

Validates and applies a CouponCode to the basket. Coupons can grant percentage or fixed-amount discounts, automatic free items, or unlock pricing tiers — the basket totals are recalculated on success.

Customer-facing flows can only add coupons while the basket is in_progress. Staff (authenticated as a User) bypass that restriction provided they have the reservations.manage permission for the site.

Returns 400 Bad Request with a human-readable reason when the coupon is invalid, expired, fully redeemed, or incompatible with the basket's items.

post/shop/basket/{basketId}/coupons

Request body

codestring required

The customer-visible coupon code to redeem. Matched case-insensitively against issued CouponCode records for the basket's site.

Example request

{
  "code": "WELCOME20"
}

Response

The updated Basket with the coupon applied.

Changes

No recorded changes to this endpoint across all 1 revision of this API.