Seller Cancellation API for EFS

Inbound | PUT | /usp/order/cancel

Summary

This API will be used by EFS to mark any order as cancelled or partially cancelled.

Description

The cancelled quantity in the payload will always be the absolute quantity.
One payload can contain information for only one order and every SKU will be present only once.
This API call can be called by External system till the Shipment is Invoiced.

Request

{
      "orderCode": "H19304030001",
      "locationCode": "l123",
      "channelName": "Myntra",
      "orderItems": [
          {
              "channelSkuCode": "100000789702",
              "cancelledQuantity": 2,
              "parentSkuCode": "PARENT001",
              "batchId": 12345,
              "clientSkuId": "SKU001",
              "externalBatchId": "EXTBATCH001",
              "mfgDate": "2024-01-01T00:00:00.000+05:30",
              "expiryDate": "2025-12-31T23:59:59.000+05:30"
          }
      ]
  }

Parameter Name	Data Type	Description	Mandatory
`orderCode`	String	Unique code used by channel to identify the order	yes
`locationCode`	String	Code used to identify a warehouse	yes
`channelName`	String	Code used to identify the channel	yes
`orderItems`	Object[]	List of order items which has to be cancelled	yes
`orderItems.channelSkuCode`	string	SKU code of order item	yes
`orderItems.cancelledQuantity`	Integer	Requested cancelled quantity of SKU. This should be less than ordered quantity	yes
`orderItems[].parentSkuCode`	String	Parent SKU code (for virtual/bundled SKUs)	No
`orderItems[].batchId`	Integer	Batch ID	No
`orderItems[].clientSkuId`	String	Client SKU ID	No
`orderItems[].externalBatchId`	String	External batch ID	No
`orderItems[].mfgDate`	ZonedDateTime	Manufacturing date	No
`orderItems[].expiryDate`	ZonedDateTime	Expiry date	No

Response

No response body (void)

HTTP Status: 200 OK on success