Inbound | POST | /orders/outward/b2c/search-items

Summary

This API can be used to search the Item level information for all the Items which are outwarded/shipped from WMS system against the a B2C Outward/Sale orders.

Description

The API will accept the Location Code and List of ShipmentID as input and return the ItemCode information for all the items shipped against the B2C sale orders.

<aside> 🗒️ Note: You can retrieve the information of ShipmentID by consuming the Outward Order Notifications for sale orders.

</aside>

Request

For B2C Sale orders:

{
    "locationCode": "Loc-1" ,
    "shipmentIds": [
        123,
        456,
        789
    ]
}
Column Column Column Column
Parameter Name Data Type Description Mandatory
locationCode String Location Identifier for which the shipment of an outward order is being searched Yes
shipmentIds List<Long> OMS Shipment identifier of the Sale order.
• B2C order can have a single shipment if order is not splitted else more than one shipment in case of splitting of order
• Max Limit: 200 Shipment in one request Yes

Response

{
   "successList":
    [
       {
        "itemCode": "Item-1" ,
        "channelSkuCode": "CSKU-1" ,
        "boxCode": "Box-1",
        "shipmentId": 123
       },
       {
        "itemCode": "Item-2" ,
        "channelSkuCode": "CSKU-1" ,
        "boxCode": "Box-1",
        "shipmentId": 123
       },
       {
        "itemCode": "Item-3" ,
        "channelSkuCode": "CSKU-2" ,
        "boxCode": "Box-1",
        "shipmentId": 123
       }
    ],
    "failureList": [
    456,
    789
  ]
}
Parameter Name Data Type Description
successList List <String> List containing the itemCode information for each SKU or box used for the Inward order
successList.itemCode String Item Code value for the SKU/Box passed in the API request
successList.channelSkuCode String SKU identifier for products for which itemCode is printed and inwarded
successList.boxCode String Identifier for boxes used to Outward the items of Sale order
successlist.shipmentId Long OMS Shipment ID for which the item information is provided
failureList List<Long> List of failed OMS Shipment IDs for which ItemCode data is not available

HTTP status

200