Cancel an order

Cancel an order, and, if applicable, payment. Changes the order status to cancelled.

Request
Request Body schema:

Order cancellation request.

ClientOrderRef
required
integer <int32>

Basket/Quotation id. Used for order matching.

ErpOrderNo
required
string

ERP order number. Used for order matching.

Array of objects <Payment> (Payment)

If supplied, a cancel call is made for all included payments. Required property for each Payment is PaymentRef.

Responses
200

Success

400

Bad Request

500

Internal Server Error

post/Order/CancelOrder
Request samples
{
  • "ClientOrderRef": 0,
  • "ErpOrderNo": "string",
  • "Payments": [
    ]
}