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_SANDBOX header 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.

MethodAPIEndpoint
GETInventory/v3/inventory
PUTUpdate inventory/v3/inventory
GETSingle item inventory per ship node/v3/inventories/{sku}
PUTUpdate item inventory per ship node/v3/inventories/{sku}
GETMultiple item inventory for all ship nodes/v3/inventories

Items

Use the Simulation APIs to create, update, and retrieve Dynamic sandbox test items.

MethodAPIEndpoint
POSTCreate item/v1/simulations/items
PUTUpdate item/v1/simulations/items/{sku}
GETAll items/v1/simulations/items
GETAn 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.

MethodAPIEndpoint
POSTCreate order/v1/simulations/orders
POSTDeliver order lines/v1/simulations/{purchaseOrderId}/deliver
GETAll Orders/v3/orders
GETAn order/v3/orders/{purchaseOrderId}
GETAll released orders/v3/orders/released
POSTAcknowledge orders/v3/orders/{purchaseOrderId}/acknowledge
POSTCancel order lines/v3/orders/{purchaseOrderId}/cancel
POSTShip order lines/v3/orders/{purchaseOrderId}/shipping

Returns and refunds

Use the returns and Simulation APIs to initiate and update test returns and issue refunds.

MethodAPIEndpoint
GETReturns/v3/returns
POSTIssue refund/v3/returns/{returnOrderId}/refund
POSTInitiate return/v1/simulations/returns
PUTUpdate return/v1/simulations/returns

Settings

Create a fulfillment center, also known as a ship node, before testing inventory workflows.

MethodAPIEndpoint
GETAll fulfillment centers/v3/settings/shipping/shipnodes
PUTUpdate fulfillment center/v3/settings/shipping/shipnodes
POSTCreate 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

MethodAPIEndpointRate limit
GETAll items/v1/simulations/items50 requests per hour
PUTUpdate item/v1/simulations/items/{sku}5 requests per hour
POSTCreate order/v1/simulations/orders5 requests per hour
POSTDeliver order lines/v1/simulations/{purchaseOrderId}/deliver50 requests per hour
GETAll orders/v3/orders50 requests per hour
POSTAcknowledge orders/v3/orders/{purchaseOrderId}/acknowledge50 requests per hour
POSTShip order lines/v3/orders/{purchaseOrderId}/shipping50 requests per hour
POSTCancel order lines/v3/orders/{purchaseOrderId}/cancel50 requests per hour
POSTInitiate return/v1/simulations/returns10 requests per hour
PUTUpdate return/v1/simulations/returns10 requests per hour

Did this page help you?