Retrieve inbound shipment items details
Call this endpoint to retrieve shipment level information such as review the SKUs that were assigned to a shipment in an inbound order, compare expected vs. received quantities at the SKU level, and to review item level receipt information.
After creating an inbound order successfully, you can use the response from the Create Inbound Shipment API to review if the order can be sent in a single shipment to one WFS fulfillment center or if it should be split into multiple shipments to different fulfillment centers. Get a shipmentId
first. Use the Get inbound shipments API to discover shipments created for an inbound order; then call this API per shipment.
Note: This page describes an example using only the required parameters and inputs to retrieve inbound shipment item details. For a full list of customization options and additional capabilities, refer to the Marketplace WFS API Reference.
Endpoint
GET https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-items
Sample request
This sample request retrieves item level SKU details for the specified inbound shipment identified using the shipmentId
.
curl --request GET \
--url 'https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-items?shipmentId=WFS1234567&offset=0&limit=50' \
--header 'WM_QOS.CORRELATION_ID: 7d2e2b4f-5b1e-4a6f-9d8f-123456789abc' \
--header 'WM_SEC.ACCESS_TOKEN: <Access_Token>' \
--header 'WM_SVC.NAME: Walmart Marketplace' \
--header 'Accept: application/json'
import requests url = "https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-items" headers = { "WM_QOS.CORRELATION_ID": "7d2e2b4f-5b1e-4a6f-9d8f-123456789abc", "WM_SEC.ACCESS_TOKEN": "<Access_Token>", "WM_SVC.NAME": "<Your_Service_Name>", "Accept": "application/json",
} params = { "shipmentId": "WFS1234567", "offset": 0, "limit": 50,
} response = requests.get(url, headers=headers, params=params)
print(response.status_code)
print(response.text)
Modify your code
- Use a unique
WM_QOS.CORRELATION_ID
for each request. - Replace
WM_SEC.ACCESS_TOKEN
with your valid access token obtained through authentication. - Replace
shipmentId
with the identifier retrieved for the shipment. To retrieve theshipmentID
, use the Get inbound shipments API.
Sample response
This sample response shows a paginated list of items that belong to the specified shipment.
{ "headers": { "limit": 10, "offset": 0, "totalCount": 4 }, "payload": [ { "inboundOrderId": "1235113", "shipmentId": "4846GDM", "gtin": "00634482736852", "sku": "ACDD-WZK73685", "itemDesc": "Blue Jeans", "itemQty": 10, "vendorPackQty": 0, "innerPackQty": 0, "receivedQty": 0, "damagedQty": 0, "fillRate": 0, "expectedDeliveryDate": "2020-09-24T00:00:00.000Z", "updatedExpectedDeliveryDate": "2020-09-24T00:00:00.000Z" }, { "inboundOrderId": "1235113", "shipmentId": "4846GDM", "gtin": "00812040019191", "sku": "KALA-WFS-KA-SWG-BL", "itemDesc": "Google mini", "itemQty": 16, "vendorPackQty": 0, "innerPackQty": 0, "receivedQty": 0, "damagedQty": 0, "fillRate": 0, "expectedDeliveryDate": "2020-09-24T00:00:00.000Z", "updatedExpectedDeliveryDate": "2020-09-24T00:00:00.000Z" }, { "inboundOrderId": "1235113", "shipmentId": "4846GDM", "gtin": "00077540052578", "sku": "NOTN-WFS-10480", "itemDesc": "Blue Jeans", "itemQty": 12, "vendorPackQty": 0, "innerPackQty": 0, "receivedQty": 0, "damagedQty": 0, "fillRate": 0, "expectedDeliveryDate": "2020-09-24T00:00:00.000Z", "updatedExpectedDeliveryDate": "2020-09-24T00:00:00.000Z" }, { "inboundOrderId": "1235113", "shipmentId": "4846GDM", "gtin": "00636047311207", "sku": "GLHF-GL1304WMST", "itemDesc": "Blue Jeans", "itemQty": 14, "vendorPackQty": 0, "innerPackQty": 0, "receivedQty": 0, "damagedQty": 0, "fillRate": 0, "expectedDeliveryDate": "2020-09-24T00:00:00.000Z", "updatedExpectedDeliveryDate": "2020-09-24T00:00:00.000Z" } ]
}
Result
If successful, the API returns an HTTP status 200 OK
with a JSON response. The response includes a paginated list of items that belong to the specified shipment.
Updated about 22 hours ago