Orders

Apply a customer credit to an order

Apply a customer credit balance to an order — for example, redeeming a refund credit or a gift balance held against the customer's profile. The updated Order is returned so the caller can see the new outstanding balance after the credit is deducted.

Returns 400 Bad Request if the credit can't be applied — for example because it has already been fully redeemed, belongs to a different customer, or is expired.

post/shop/orders/{orderId}/customer-credits

Request body

idstring required

Identifier of the CustomerCredit to apply to this order. Customer credits are managed under the Customers API and must belong to a customer linked (directly or via a guest) to this order.

Example request

{
  "id": "5ed2b95f72823c4f98419f19"
}

Response

The Order was successfully retrieved

Changes

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