Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inbound | PUTĀ  | /orders/{orderCode}/cancel

...

This API is used to push complete as well as partial cancellation of outward orders. The canceled quantity in the payload will always be the absolute quantity. One payload can have only one order and one sku can be present only once.

Note :

  1. Before invoicing : Any type of cancellation including partial and complete is allowed.

  2. After invoicing : No cancellation is allowed

Request

Code Block
languagejson
{
   "locationCode":"locationCode",
   "orderItems":[
      {
         "channelSkuCode":"100000789702",
         "cancelledQuantity":1,
         "orderItemCode":"item123"
      },
      {
         "channelSkuCode":"100000789703",
         "cancelledQuantity":4,
         "orderItemCode":"item124"
      }
   ]
}

Parameter Name

Data Type

Description

Mandatory

orderCode

String

Unique code used by channel to identify the order

yes

locationCode

String

Location code of the warehouse from where the order will get fulfilled

yesno

orderItems

Object[]

List of order items which got cancelled

yes

orderItems.channelSkuCode

String

SKU code of order item

yes

orderItems.cancelledQuantity

Integer

Absolute Quantity of SKU which got cancelled. This should be less than the ordered quantity

yes

orderItems.orderItemCode

String

This is provided by the channel to uniquely identify each order item.

yes

...

Empty Body

HttpStatus Code

200