CancelOrderCompensation

Cancel (parts) of a previously compensated order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

We expect the remaining compensation amount in the compensationAmountInCents field. An amount of 0 is to indicate the cancellation of the entire order.

We will return a 200 OK if the order was not previously cancelled and 400 BadRequest if it was. A higher amount than the current compensation amount will cause a 400 BadRequest, an equal number will return a 200 OK.

A 400 BadRequest is returned when supplying a currency different to the original compensation.

example 1

An order was placed containing 2 products:

  • product 1 with compensation amount 60 cents
  • product 2 with compensation amount 40 cents

The compensation paid for this order and sent to our api was €1,00.

When product 1 is returned and refunded and you want to cancel this part of the order compensation accordingly, you should send the remaining amount of the order compensation, in this case 40 cents.

example 2

An order was placed containing 2 products:

  • product 1 with compensation amount 60 cents
  • product 2 with compensation amount 40 cents

The compensation paid for this order and sent to our api was €1,00.

When the order is cancelled and you want to cancel the order compensation accordingly, you should send the remaining amount of the order compensation, in this case 0 cents.

Body Params
string
required
Defaults to 123
string
required
Defaults to USD

The currency of this order in ISO 4217 e.g. EUR or USD.

int32
required
Defaults to 10
Headers
string
required
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json