Use this endpoint to retrieve a list of your WFS inbound shipments and their high-level details (status, destination FC, key dates). This is most useful for building shipment dashboards, reconciling what’s already created, or drilling into a specific shipment.

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.

Note: This page describes an example using only the required parameters and inputs to retrieve inbound shipment 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-shipments

Sample request

This section shows sample requests to list all the shipments in an inbound order and how to retrieve details for a specific shipment.

List shipments

This sample request demonstrates how to fetch inbound shipments in batches using the offset and limit query parameters.

curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipments?offset=0&limit=50&status=IN_TRANSIT' \ --header 'WM_QOS.CORRELATION_ID: 2f9d8f2b-9d7a-4f2e-9a6b-9c4e7b7d1e21' \ --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)

Specific shipment

This sample request demonstrates how to retrieve the details for a specific inbound shipment using shipmentId.

curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipments?shipmentId=WFS1234567' \ --header 'WM_QOS.CORRELATION_ID: 6e8a7c4c-8a8d-4dc5-9a9d-1b2c3d4e5f6a' \ --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-shipments" headers = { "WM_QOS.CORRELATION_ID": "6e8a7c4c-8a8d-4dc5-9a9d-1b2c3d4e5f6a", "WM_SEC.ACCESS_TOKEN": "<Access_Token>", "WM_SVC.NAME": "Walmart Marketplace", "Accept": "application/json",
} params = { "shipmentId": "WFS1234567",
} 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 the shipmentID, use the Get inbound shipments API.

Sample response

The sample response shows a paginated, item level of the specified shipment.

{ "headers": { "limit": 10, "offset": 0, "totalCount": 177 }, "payload": [ { "inboundOrderId": "month-date-test-2", "shipmentId": "0066618GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "12345", "countryCode": "Country code, example: USA", "postalCode": "Two letter state, example: KY" }, "status": "AWAITING_DELIVERY", "createdDate": "2021-05-17T19:02:30.467Z", "shipmentUnits": 1, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-22T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-06-01T23:59:00.000Z", "trackingNo": [ "787439195645", "787439195174" ], "carrierName": "WFS-FEDEX" }, { "inboundOrderId": "may-21-test9", "shipmentId": "0061782GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "CANCELLED", "createdDate": "2021-05-06T17:49:54.743Z", "shipmentUnits": 0, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-20T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-20T00:00:00.000Z" }, { "inboundOrderId": "may-21-test8", "shipmentId": "0061779GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "95391" }, "status": "CANCELLED", "createdDate": "2021-05-06T17:42:42.577Z", "shipmentUnits": 0, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-20T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-06-01T23:59:00.000Z", "trackingNo": [ "787450289224" ], "carrierName": "WFS-FEDEX" }, { "inboundOrderId": "month-date-test7", "shipmentId": "0061763GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "CANCELLED", "createdDate": "2021-05-06T16:54:47.310Z", "shipmentUnits": 0, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-20T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-20T00:00:00.000Z" }, { "inboundOrderId": "may-21-test6", "shipmentId": "0061752GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "CANCELLED", "createdDate": "2021-05-06T16:31:22.383Z", "shipmentUnits": 0, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-20T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-20T00:00:00.000Z" }, { "inboundOrderId": "may-21-test-3", "shipmentId": "0061726GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "PENDING_SHIPMENT_DETAILS", "createdDate": "2021-05-06T15:09:35.797Z", "shipmentUnits": 1, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-20T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-20T00:00:00.000Z" }, { "inboundOrderId": "may-21-test-2", "shipmentId": "0061712GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "PENDING_SHIPMENT_DETAILS", "createdDate": "2021-05-06T14:31:32.280Z", "shipmentUnits": 3, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-20T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-20T00:00:00.000Z" }, { "inboundOrderId": "may-21-test-1", "shipmentId": "0061665GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "PENDING_SHIPMENT_DETAILS", "createdDate": "2021-05-06T14:23:28.673Z", "shipmentUnits": 1, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-20T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-20T00:00:00.000Z" }, { "inboundOrderId": "may-4-test-2", "shipmentId": "0060645GDM", "shipToAddress": { "fcName": "NJ3", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "PENDING_SHIPMENT_DETAILS", "createdDate": "2021-05-05T01:24:25.840Z", "shipmentUnits": 1, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-22T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-22T00:00:00.000Z" }, { "inboundOrderId": "month-date-test-1", "shipmentId": "0060635GDM", "movedShipmentId": "0060634GDM", "shipToAddress": { "fcName": "KY1", "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "returnAddress": { "addressLine1": "Street address", "city": "Name of the city", "stateCode": "Two letter state, example: KY", "countryCode": "Country code, example: USA", "postalCode": "12345" }, "status": "AWAITING_DELIVERY", "createdDate": "2021-05-04T23:46:18.530Z", "shipmentUnits": 1, "receivedUnits": 0, "expectedDeliveryDate": "2021-05-23T00:00:00.000Z", "updatedExpectedDeliveryDate": "2021-05-19T23:59:00.000Z", "trackingNo": [ "787095506139" ], "carrierName": "WFS-FEDEX" } ]
}

Result

If successful, the API returns 200 OK with a JSON body. The response includes a paginated list of items that belong to the specified shipment.