Guides
My Account

Walmart sandbox

Test your API app before going live

Use the Walmart sandbox to build, simulate, and troubleshoot your 1P Supplier integration before you launch to production. The sandbox APIs mirror all production APIs, but return mock data. They do not write or persist data.

What you can do

  • Run end‑to‑end integration flows with dynamic mock responses
  • Validate feed schemas and request/response formats
  • Download sample reports
  • Exercise error paths and edge cases
  • Iterate safely during development

Sandbox base URL

The base URL for the Walmart sandbox is https://sandbox.walmartapis.com.

Tip: Use the same paths and query parameters in sandbox and production. Only the base URL changes.

How it works

Sandbox responses use mock datasets. Each sandbox endpoint exposes one or more datasets that simulate common real‑world scenarios. Responses are dynamic—they can change based on your input (path params, query params, or headers).

  • Read‑only: No write operations. No data persistence.
  • Dataset‑backed: Each endpoint may provide a /dataset view that shows the mock payloads available for that endpoint.

Note: Feature coverage is broad but may not include every production edge case.

Sandbox use cases

You can use the sandbox to:

  • Perform integration testing with dynamic responses that change based on your input.
  • Perform schema-level validations for feeds.
  • Download sample reports.
  • Test while developing to find and fix issues before going live.
  • Try new features and provide feedback before making changes in production.

Limitations

The Walmart sandbox does not:

  • Persist data or support write operations.
  • Guarantee full parity with production features or rare edge cases.
  • Support performance/load testing or capacity benchmarking.
  • Offer production SLAs.

If you need to validate behavior that depends on live data or systems of record, plan a controlled smoke test in production after your sandbox validation.

Using mock datasets

The Walmart sandbox uses mock datasets to simulate API responses. These datasets help you test how your app handles data without affecting live data. Use the mock datasets to see the data returned for a specific API response in the sandbox.

Accessing mock data

Get a dataset for an endpoint

  1. Identify the sandbox API URL you want to call.
  2. Append /dataset to the path.
  3. Send the request with the same headers you use in production.

Example - GET report dataset

To return the mock dataset for the /reports API, replace your-request-id in the following code example with the request ID you use in your testing scenarios.

GET https://sandbox.walmartapis.com/v3/reports/downloadReport?requestId=your-request-id

curl -X GET \
'https://sandbox.walmartapis.com/v3/reports/downloadReport/dataset?requestId=123e4567-e89b-12d3-a456-426614174000' \
-H 'Accept: application/json' \
-H 'WM_SEC.ACCESS_TOKEN: <sandbox-access-token>' \
-H 'WM_QOS.CORRELATION_ID: test-123' \
-H 'WM_SVC.NAME: Reports'

Example response

{
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"reportType": "DAILY_SALES",
"status": "READY",
"downloadUrl": "https://sandbox-assets.walmartapis.com/reports/DAILY_SALES_2024-10-20.csv",
"generatedAt": "2024-10-20T07:15:00Z"
}

Errors and status codes

The Walmart sandbox returns standard HTTP status codes. Expect the same contract as production unless otherwise noted.

Common codes

  • 200 OK – Dataset or mock response returned
  • 400 Bad Request – Invalid or missing parameters
  • 401/403 – Authentication/authorization failure
  • 404 Not Found – No dataset matched the request
  • 429 Too Many Requests – Rate limit exceeded
  • 5xx – Simulated server error

Example error body

{
"error": { "code": "DATASET_NOT_FOUND", "message": "No mock dataset matched the provided parameters.", "correlationId": "test-123", "requestId": "123e4567-e89b-12d3-a456-426614174000" }
}

Market availability

The Walmart sandbox is available wherever 1P Supplier APIs are supported.

Next step

Get sandbox credentials .

Updated 12 days ago