Dynamic sandbox

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.

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