Seller Cancellation API

Outbound | PUT | {Client’s URL}

Summary

This API is used by Increff to push order cancellation done by Seller to the Shopfront channel.

Description

This API will be used to push complete or partial cancellation from the seller to the Shopfront channel (Ecommerce Website/Webshop).
The canceled quantity in the payload will always be the absolute quantity.
One payload can have only one order and will include all line items for that order. The cancelledQuantity for each line item determines whether that item is actually cancelled, and only the relevant quantity is marked as cancelled. This call can be made till order is invoiced.

Request

{
   "orderCode":"H19304030001",
   "locationCode":"l123",
   "orderItems":[
      {
         "channelSkuCode":"100000789702",
         "cancelledQuantity":5,
         "orderItemCode":"item123",
         "customerCancelledQty":1,
         "sellerCancelledQty":4,
         "acceptedQty":1,
         "sellerRejectQty":1
      },
      {
         "channelSkuCode":"100000789703",
         "cancelledQuantity":4,
         "orderItemCode":"item124",
         "customerCancelledQty":2,
         "sellerCancelledQty":2,
         "acceptedQty":1,
         "sellerRejectQty":1
      }
   ]
}

Parameter Name	Data Type	Description	Mandatory
`orderCode`	String	Unique code used by channel to identify the order	Yes
`locationCode`	String	Code used by channels to identify a warehouse	No
`orderItems`	Object[]	List of all order line items in the cancellation payload. Items with a relevant `cancelledQuantity` will be marked as cancelled for that quantity.	Yes
`orderItems.channelSkuCode`	string	SKU code of order item	Yes
`orderItems.cancelledQuantity`	Integer	The `cancelledQuantity` will determine which items are actually cancelled, with only the relevant quantity being marked as cancelled. It shows the total cancelled quantity so far for the item, not just the newly cancelled quantity.	Yes
`orderItems.orderItemCode`	String	This is provided by the channel to uniquely identify each order item.	Yes
`orderItems.customerCancelledQty`	Integer	Total customer cancelled quantity of SKU	No
`orderItems.sellerCancelledQty`	Integer	Requested cancelled quantity of SKU	No
`orderItems.acceptedQty`	Integer	The total quantity accepted by stores	No
`orderItems.sellerRejectQty`	Integer	The total quantity rejected by stores	No

Response

HttpStatusCode

200

{
    "hasError":false,
    "errorMessage":"Error message"
}