Get Shipments

After Sellers create an Inbound Order successfully, the response from Create Inbound Shipments API will tell whether the order can be sent in a single shipment to one WFS fulfillment center or needs to be split into multiple shipments to different fulfillment centers. To retrieve the Shipment level info, please call the Get Inbound Shipments API.

Market availability: Global

Query Params
string
Defaults to 0

offset is the number of records you wish to skip before selecting records.

Market availability: Global

string
Defaults to 10

The number of Purchase Orders to be returned.

Market availability: Global

string

Unique ID identifying inbound shipment request.

Market availability: Global

string

Unique ID identifying each shipment.

Market availability: Global

string
enum

Filters results based on the current shipment status.

Market availability: Global

string

Start date for the shipment creation date range.

Date Format : ISO 8601 date or datetime format.

Timezone : UTC

Examples:
1. 2025-05-30 (interpreted as 2020-03-16T00:00:00Z)
2. 2025-05-30T10:30:15Z

Notes:
When a date without time is provided, it defaults to midnight UTC.
Use the Z suffix to indicate UTC (Z=Zulu time=UTC).
Market availability: Global

string

End date for the shipment creation date range.

Date Format : ISO 8601 date or datetime format.

Timezone : UTC

Examples:
1. 2025-05-30 (interpreted as 2020-03-16T00:00:00Z)
2. 2025-05-30T10:30:15Z

Notes:
When a date without time is provided, it defaults to midnight UTC.
Use the Z suffix to indicate UTC (Z=Zulu time=UTC).
Market availability: Global

Headers
string
required

Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs.

Market availability: Global

string

A unique ID to identify the consumer request by channel. Use the Consumer Channel Type received during onboarding.

Market availability: Global

string
required

A unique ID that identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.

Market availability: Global

string
required

Specifies the name of the Walmart service being called.

Market availability: Global

string
enum
required

Indicates the global version of the API. The value must be set to 3.1.

Market availability: Global

Allowed:
string
enum
required

Identifies the Walmart Marketplace region for the request. If not specified, US is used by default.

Market availability: Global

Allowed:
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json