Download scan form

get

https://marketplace.walmartapis.com/v3/shipping/scan-form

This API retrieves a scan form for a given manifest ID.

Rate Limits: This endpoint allows 100 requests per minute. Exceeding this limit returns a 429 Too Many Requests response. See the Rate Limiting guide for full details. The response includes x-current-token-count (remaining requests in the current window) and X-Next-Replenishment-Time (when the token count next increases).

Sandbox: Use base URL https://sandbox.walmartapis.com. The sandbox returns a stub binary document for any valid sandbox manifestId. The documentFormat selection (PDF/ZPL/PNG) is honored in production; in sandbox, a PDF stub is always returned regardless of the format requested during scan form creation.

Note: This endpoint returns a binary document stream (application/octet-stream). Treat the response body as bytes and save it to a file. The underlying document format aligns with the scan form documentFormat selected during creation (for example, PDF, ZPL, PNG).

Query Params

manifestId

string

required

Manifest ID returned by the create scan form API. Use this value to download the scan form document.

Headers

WM_CONSUMER.CHANNEL.TYPE

string

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

Market availability: Global

WM_QOS.CORRELATION_ID

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

WM_SVC.NAME

string

required

Specifies the name of the Walmart service being called.

Market availability: Global

WM_MARKET

string

enum

required

Case-sensitive market identifier. Valid values: US

Market availability: Global

Allowed:

WM_GLOBAL_VERSION

string

enum

required

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

Market availability: Global

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/octet-stream

200Successful operation