Dynamic sandbox
Market availability: US only
The Walmart Marketplace API dynamic sandbox is a self-service testing environment where you can build and validate your integration without affecting production data. Unlike the static sandbox, which returns Walmart-provided mock responses, the dynamic sandbox lets you create custom test data and test multi-step workflows such as item setup, inventory management, order fulfillment, delivery, returns, and refunds.
Why use the Dynamic sandbox
Testing in production can affect live catalog data, inventory, orders, and seller operations. The Dynamic sandbox provides an isolated environment where you can safely:
- Build and test your integration before going live.
- Validate end-to-end workflows across multiple APIs.
- Create test scenarios using custom data.
- Test business validations and error handling.
- Troubleshoot integration issues without using production accounts.
- Quickly and easily simulate customer actions, such as placing orders, initiating returns, and issuing refunds.
Note: Changes made in the Dynamic sandbox do not affect production seller data, Walmart.com, live transactions, or other sandbox users. Dynamic sandbox data does not appear in Seller Center.
How it works
Dynamic sandbox workflows use Marketplace APIs and Simulation APIs together.
- Marketplace APIs let you retrieve and process sandbox data.
- Simulation APIs trigger actions that would normally be performed by customers, carriers, or other systems, such as placing an order, delivering a package, or initiating a return.
For example, you can:
- Create a test item and add inventory.
- Place and retrieve a test order.
- Acknowledge, ship, and deliver the order.
- Initiate and process a return.
Explore Marketplace recipes for step-by-step guidance on testing common workflows in the Dynamic sandbox.
Access the Dynamic sandbox
Send requests to the following base URL:
https://sandbox.walmartapis.com
Use your Dynamic sandbox API credentials when calling the sandbox environment. Production credentials cannot be used with the Dynamic sandbox.
Include the following header to route requests to the Dynamic sandbox:
WM_SANDBOX: v2
Note: If the
WM_SANDBOXheader is omitted, null, or contains another value, the request is routed to the static sandbox.
List of APIs available in Dynamic sandbox
The following sections list the Marketplace and Simulation APIs currently available for Dynamic sandbox testing.
Inventory
Use the inventory APIs to update and retrieve non-WFS inventory by ship node. You can also test updating current inventory counts, inventory decrements, and stockout scenarios.
| Method | API | Endpoint |
|---|---|---|
| GET | Inventory | /v3/inventory |
| PUT | Update inventory | /v3/inventory |
| GET | Single item inventory per ship node | /v3/inventories/{sku} |
| PUT | Update item inventory per ship node | /v3/inventories/{sku} |
| GET | Multiple item inventory for all ship nodes | /v3/inventories |
Items
Use the Simulation APIs to create, update, and retrieve Dynamic sandbox test items.
| Method | API | Endpoint |
|---|---|---|
| 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
Use the Simulation APIs to place and deliver test orders. Use the standard orders APIs to retrieve, acknowledge, fulfill, or cancel the orders.
| Method | API | Endpoint |
|---|---|---|
| POST | Create order | /v1/simulations/orders |
| POST | Deliver order lines | /v1/simulations/{purchaseOrderId}/deliver |
| 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 |
Returns and refunds
Use the returns and Simulation APIs to initiate and update test returns and issue refunds.
| Method | API | Endpoint |
|---|---|---|
| GET | Returns | /v3/returns |
| POST | Issue refund | /v3/returns/{returnOrderId}/refund |
| POST | Initiate return | /v1/simulations/returns |
| PUT | Update return | /v1/simulations/returns |
Settings
Create a fulfillment center, also known as a ship node, before testing inventory workflows.
| Method | API | Endpoint |
|---|---|---|
| GET | All fulfillment centers | /v3/settings/shipping/shipnodes |
| PUT | Update fulfillment center | /v3/settings/shipping/shipnodes |
| POST | Create fulfillment center | /v3/settings/shipping/shipnodes |
Note: Marketplace APIs not included in the preceding sections continue to use the static sandbox and return Walmart-provided mock datasets that cannot be customized.
About Simulation APIs
Simulation APIs use the /v1/simulations path and are available only in the Dynamic sandbox. Use these APIs to simulate actions performed by non-seller entities, including:
- Customers placing orders.
- Customers initiating returns.
- Carriers delivering packages.
These simulated events generate the test data needed to validate end-to-end Marketplace workflows. After triggering an event, use the corresponding Marketplace APIs to retrieve and process the resulting data.
If you omit optional request attributes, Walmart automatically generates default test data that satisfies the minimum requirements for the simulated workflow.
For request schemas and examples, refer to the Simulation API Reference.
Dynamic sandbox considerations
The following considerations apply when testing in the Dynamic sandbox:
- Full item setup through feeds is not supported.
- Test item creation supports customization of only a subset of item schema attributes.
- Placing a test order does not require a valid payment method or delivery address.
- Shipping a test order does not require a valid tracking number.
- Creating a test return does not require a valid tracking number.
- Issuing a test refund does not require a valid payment method.
- Test item creation is limited to 25 items.
- Test order creation is limited to 25 orders.
- Fulfillment center creation is limited to one fulfillment center.
- Fulfillment center addresses are not validated.
- Walmart deletes all Dynamic sandbox data every two days.
When creating test items, placing test orders, or initiating returns, you can provide supported optional attributes to customize your test scenario. If an optional attribute is omitted, Walmart may generate test data to satisfy the minimum data requirements.
Dynamic sandbox API rate limits
| Method | API | Endpoint | Rate limit |
|---|---|---|---|
| GET | All items | /v1/simulations/items | 50 requests per hour |
| PUT | Update item | /v1/simulations/items/{sku} | 5 requests per hour |
| POST | Create order | /v1/simulations/orders | 5 requests per hour |
| POST | Deliver order lines | /v1/simulations/{purchaseOrderId}/deliver | 50 requests per hour |
| GET | All orders | /v3/orders | 50 requests per hour |
| POST | Acknowledge orders | /v3/orders/{purchaseOrderId}/acknowledge | 50 requests per hour |
| POST | Ship order lines | /v3/orders/{purchaseOrderId}/shipping | 50 requests per hour |
| POST | Cancel order lines | /v3/orders/{purchaseOrderId}/cancel | 50 requests per hour |
| POST | Initiate return | /v1/simulations/returns | 10 requests per hour |
| PUT | Update return | /v1/simulations/returns | 10 requests per hour |
Updated 11 days ago

