Inbound | PUT | /orders/cancel
Summary
This API is used by Increff to push order cancellation to the channel.
Description
This API will be used to push complete or partial cancellation from the seller to the channel. The canceled quantity in the payload will always be the absolute quantity. One payload can have only one order and one SKU will be present only once. This call can be made till order is invoiced.
Request
{
"orderCode":"H19304030001",
"locationCode":"l123",
"channelId":"l123",
"orderItems":[
{
"clientSkuId":"100000789702",
"cancelledQuantity":1,
},
{
"clientSkuCode":"100000789703",
"cancelledQuantity":4
}
]
}
Parameter Name | Data Type | Description | Mandatory |
| String | Unique code used by channel to identify the order | yes |
| String | Code used to identify a warehouse | yes |
| String | Code used to identify the channel | yes |
| Object[] | List of order items which has to be cancelled | yes |
| string | SKU code of order item | yes |
| Integer | Requested cancelled quantity of SKU. This should be less than ordered quantity | yes |