Baskets

Apply a customer credit to a Basket

Applies one of the customer's outstanding CustomerCredit balances against the basket. Customer credits are issued by operators as compensation, refunds-to-store-credit, or loyalty rewards; once applied to a basket they reduce the outstanding payment amount immediately.

Returns 400 Bad Request if the credit can't be redeemed — for example because it's been fully spent, has expired, or doesn't belong to the basket's customer.

post/shop/basket/{basketId}/customer-credits

Request body

idstring object-id required

ID of the CustomerCredit to redeem against the basket. Must belong to the customer attached to the basket and have a remaining balance.

Example request

{
  "id": "5f6666666666666666666666"
}

Response

The updated Basket with the customer credit applied.

Changes

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