Versions Compared

Key

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

...

...

...

Inbound |

...

PUTĀ  |

...

/orders/{orderCode}/cancel

Summary

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

...

Code Block
{
   "orderCode":"H19304030001",
   "locationCode":"l123",
   "channelId":"l123",
   "orderItems":[
      {
         "channelSkuCodeclientSkuId":"100000789702",
         "cancelledQuantity":1,
   
     "orderItemCode":"item123"       },
      {
         "channelSkuCodeclientSkuCode":"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

Code used by channels to identify a warehouseno

yes

channelId

String

Code used to identify the channel

yes

orderItems

Object[]

List of order items which has to be cancelled

yes

orderItems.channelSkuCodeclientSkuCode

string

SKU code of order item

yes

orderItems.cancelledQuantity

Integer

Requested cancelled quantity of SKU. This should be less than ordered quantity

yes

orderItems.orderItemCode

String

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

yes

Response

HttpStatusCode 200