Walmart sandbox

Test your API before going live

The Walmart sandbox is an environment for testing Walmart APIs before you launch your app. As a seller or solution provider, you can run simulations, debug, generate reports, and monitor API behavior before moving to production.

All Marketplace APIs available in production are available for testing in the sandbox.

How it works

There are two Walmart sandbox environments: the static sandbox, and the dynamic sandbox.

Static

Market availability: Global market

The static sandbox uses read-only mock datasets to simulate real-world scenarios. Each endpoint available in the sandbox contains one or more mock datasets. Unlike a production environment, the sandbox doesn't support write capabilities and data persistence.

Dynamic

Market availability: US only

The dynamic sandbox lets you create custom test data. You can use the dynamic sandbox to simulate end-to-end flows before going live. Only a subset of Marketplace APIs support the dynamic sandbox.

Responses to all sandbox API calls return data based on your input. You can test different scenarios and view how your app handles different responses.

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.

Using mock datasets in the static sandbox

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 view the data returned for a specific API response in the sandbox.

Accessing mock data

To view the mock dataset for a specific sandbox API:

  • Identify the sandbox API URL you want to use.
  • Add /dataset to the end of the URL.

Example

Sandbox API call:

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

To get the mock dataset:

  1. Add /dataset and call GET https://sandbox.walmartapis.com/v3/reports/downloadReport/dataset?requestId=your-request-id.
  2. Replace your-request-id with the request ID you use in your testing scenarios.

Step result: The sandbox returns the mock dataset that matches your API input.

Market availability

The Walmart static sandbox is available for Marketplace in U.S., Chile, Mexico, and Global.

The Walmart dynamic sandbox is available for Marketplace in the U.S. only.

Next steps

Get sandbox credentials and start testing your Marketplace integration.

Sandbox guide

The MCS API sandbox supports custom test data simulation, enabling users to create, modify, and manage their own mock data for testing end-to-end workflows. Learn more at WFS Multichannel Solutions (MCS) API Sandbox Guide.