XM

Cancel Orders By Order ID

Path:

POST /api-order/orders/user?offset=0&limit=10

This API offers the flexibility to cancel an order, within 24 hours of placing the order or before the order is shipped.

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 : query

Name : offset and limit

Required: true

Type: body

Name: Order details

Required: true

Sample Request

[{
"orderId": "2142-6901-42401",
"cancellationCode": "1001"
},{
"orderId": "2917-6975-81013",
"cancellationCode": "2001"
}]

Response

Response Code: 200

Message: OK

Sample

[{
"orderId": "2142-6901-42401",
"status": "Successfully cancelled order"
},{
"orderId": "2917-6975-81013",
"status": "Successfully cancelled order"
}]

Error Code: 400

Message: Bad Request - Invalid Order Cancellation (Order placed more than 24 hours ago)

Error Code: 404

Message: Order Not Found

Changelog

  • Last Updated - April 2021

  • First Updated - July 2020