Sign in
Care

Create a refund on an Orderline

Rate limiting

This endpoint is rate limited to 500 requests per day. If you exceed this limit, you will receive a 429 status code.

post/ws/sav/refund

Request body

amountnumber

Amount of the refund. Only if refund type is 6

orderline_pkinteger

ID of the Orderline to be refund

refund_type4 | 5 | 6

Type of the refund:

  • 4 - Full refund for an orderline with state 1
  • 5 - Full refund for an orderline with state 2
  • 6 - Partial or full refund for an orderline with state 3

Details of the orderline states:

StateDescription
0New Orderline
1Orderline paid by the customer
2Orderline accepted by the seller
3Orderline delivered to the shipping provider
4Orderline cancelled
5Orderline refunded before shipping
6Orderline refunded after shipping
7Orderline not paid
8Orderline pending customer payment

Example request

{
  "amount": 89.99,
  "orderline_pk": 123,
  "refund_type": 4
}

Response

Refund Created

Changes

No recorded changes to this endpoint across all 3 revisions of this API.