XM

Cancel Order

Path:

POST /api-order/orders/shipments

This API offers the flexibilty to you and your customers to cancel an order within 24-hour from when the Order Status = Order_payment_authorized in the OMS.

Headers

x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

x-api-key : d41d8cd98f00b204e9800998ecf8427e

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: body

Name: Order details

Required: true

Sample Request

{
"orderId": "8568-9704-74294",
"cancellationCode": "2001"
}

Response

Response Code: 200

Message: OK

Sample

{
"orderId": "8568-9704-74294",
"status": "Successfully cancelled order"
}

Error Code: 404

Message: Order Not Found

Changelog

  • Last Updated - April 2021

  • First Updated - July 2020