Get Item Barcode Details API (For B2B Orders)

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

Summary

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

Description

The API will accept the Location Code and ShipmentID as input and return the ItemCode information for all the items shipped against the B2B sale orders for one shipment.
You can pass the SKU or Box information in the API request if you need to retrieve Item information for some particular SKUs or boxes specifically.

<aside> 🗒️ Note:

Only one Shipment ID can be passed in the API request since there can be multiple boxes and large number of items in the result set.
You can retrieve the information of ShipmentID by consuming the Outward Order Notifications for sale orders. </aside>

Request

For B2B Sale orders:

{
  "locationCode": "Loc-1" ,
  "shipmentId": "123",
   "channelSkuCodes": [
        "CSKU-1",
        "CSKU-2",
        "CSKU-3"
    ],
    "boxCodes": [
        "test_789098a4369c", "test_789098a4369D"
    ]
}

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
`shipmentId`	String	OMS Shipment identifier for the Sale order.Note:
• B2B order can have multiple shipments.
• You can pass one Shipment ID at a time for any order since the list of items can be large in number.	Yes
`channelSkuCodes`	String	SKU identifier for products outwarded. Supports only for COMPLETED orders. Max Limit: 500 SKUs in one request	No
`boxCodes`	String	Identifier for boxes used to inward the products of purchase orderMax Limit: 50 BoxCodes in one request	No

Response

  "itemsData": [
    {
      "shipmentId": 76,
      "itemCode": "test_74cdd4d30453",
      "channelSkuCode": "test_ec5a7f120c33",
      "boxCode": "test_789098a4369c"
    },
    {
      "shipmentId": 76,
      "itemCode": "test_74cdd4d30454",
      "channelSkuCode": "test_ec5a7f120c33",
      "boxCode": "test_789098a4369c"
    },
    {
      "shipmentId": 76,
      "itemCode": "test_74cdd4d30455",
      "channelSkuCode": "test_ec5a7f120c33",
      "boxCode": "test_789098a4369d"
    },
    {
      "shipmentId": 76,
      "itemCode": "test_74cdd4d30456",
      "channelSkuCode": "test_ec5a7f120c33",
      "boxCode": "test_789098a4369d"
    }
  ]
}

Parameter Name	Data Type	Description
`itemsData`	Object	List containing the information of `shipmentId`, `itemCode`, `channelSkuCode` , `boxCode` for the B2B shipments.
`itemsData.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	Shipment ID for which the item information is provided

HTTP status