Seller Cancellation API for EFS

Owned by Shivani Verma (Unlicensed)
Last updated: Nov 03, 2023 by Alaf Azam Khan
1 min read

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":"l123",    "orderItems":[       {          "channelSkuCode":"100000789702",          "cancelledQuantity":1       },       {          "channelSkuCode":"100000789703",          "cancelledQuantity":4       }    ] }

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

Response

HttpStatusCode 200

Â