Guides
My Account

Walmart sandbox

Test your API app before going live

Suggest Edits

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

The Walmart sandbox uses dynamic mock datasets to simulate real-world scenarios. The sandbox is a read-only mock dataset. 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.

Sandbox APIs provide dynamic responses, meaning the data returned can change based on your input. You can test different scenarios and see how your app handles different responses.

Note: The sandbox provides only mock responses. It doesn't have a staging environment for sellers and solution providers to test an API.

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

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

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 sandbox is available for Marketplace in Chile, Mexico, and the U.S.

Next steps

Get sandbox credentials and start testing your Marketplace integration.

Updated 25 days ago