Walmart sandbox

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.

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.

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.

Accessing the dynamic sandbox environment

To call the Marketplace API sandbox, direct your API requests to the base URL https://sandbox.walmartapis.com.

To access the dynamic sandbox environment, include the header parameter WM_SANDBOX: v2. Any null or other value in this header will direct your request to the static sandbox.

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.

Using custom data in the dynamic sandbox

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

Dynamic sandbox APIs that support custom data

The following sections list the Marketplace dynamic sandbox APIs that support custom test data.

Items

Create, update, and retrieve dynamic sandbox test items using the following APIs:

• POST Create Item - /v1/simulations/items

• PUT Update Item - /v1/simulations/items/{sku}

• GET All items - /v1/simulations/items

• GET An item - /v1/simulations/items/{sku}

Orders

Place, retrieve, and fulfill dynamic sandbox test orders using the following APIs:

• POST Create Order - /v1/simulations/orders

• GET All Orders - /v3/orders

• GET An Order – /v3/orders/{purchaseOrderId}

• GET All Released Orders - /v3/orders/released

• POST Acknowledge Orders - /v3/orders/{purchaseOrderId}/acknowledge

• POST Cancel Order Lines - /v3/orders/{purchaseOrderId}/cancel

• POST Ship Order Lines - /v3/orders/{purchaseOrderId}/shipping

• POST Deliver Order Lines - /v1/simulations/{purchaseOrderId}/deliver

Marketplace APIs not included in the preceding list continue to use the static sandbox, returning only the non-customizable mock datasets provided by Walmart.

About Simulation APIs

Simulation APIs (v1/simulations) are dynamic sandbox-only APIs that allow you to simulate the actions of entities not otherwise available in the sandbox, such as customers placing orders or carriers delivering packages. Simulation APIs ensure end-to-end flows can be fully simulated in the sandbox according to your needs.

For detailed information about the Simulation APIs, refer to the Simulation API reference pages.

Custom test data limitations

• The dynamic sandbox does not support full item set-up using feeds. Test item creation supports customization of only a subset of item schema attributes.

• Placing dynamic sandbox test orders does not require a valid payment method or valid delivery address.

• Shipping dynamic sandbox test orders does not require a valid tracking number.

• When creating test items and placing test orders in the dynamic sandbox environment, you have the option to populate a large number of schema attributes. If you do not wish to populate these optional attributes, then Walmart will generate mock test data on your behalf to satisfy any data sufficiency requirements.

• The test item creation limit is 25 items.

• The test order creation limit is 25 orders.

• All sandbox data is deleted by Walmart every 2 days.

Dynamic sandbox API rate limits

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.