Sandbox

Walmart API Sandbox

The Walmart API Sandbox provides an environment to test Walmart APIs to ensure a successful integration and production launch. The Sandbox is only for backend testing of APIs and there is not an option to view or test on Walmart.com. This environment uses test-only elements and simulated responses (based on mock data) and calls to applications in realtime.

All URLs, Endpoints, Users, Items, Orders, and currency/funds within the Sandbox are for testing purposes only. This environment provides production simulation, debugging, reports and ability to monitor API behavior before moving to production.

Note: The beta launch includes the Sandbox Marketplace APIs, including JSON/XML samples (except XML Order samples).

Benefits to using the Walmart API Sandbox

The Sandbox provides the ability to:

  • Test the integration process by accessing simulation APIs that you can call from your applications, in realtime.
  • Perform basic validations on the feeds, payloads, etc. to lessen data quality issues on production.
  • Deploy with confidence as all test failures occur in a safe environment.
  • Test in parallel with development to address any issues prior to going live.
  • Try out new features and provide feedback before changes are pushed to production.

Workflow

The Sandbox workflow encourages simulation of the API integration with Walmart. The Sandbox environment works in conjunction with API Explorer and SDK to create greater focus on trying and learning APIs.

The basic Sandbox workflow after registration includes these steps:

  • Learn – Read the Developer Center documentation
  • Try – Developer Center API Explorer/Swagger, SDK
  • Integrate – SDK/Sandbox APIs
  • Simulate – Sandbox APIs
  • Go Live – Production APIs

Authentication and Authorization

Authentication involves getting your keys and authorization involves providing access keys for your Solution Providers (Delegated Access).

To use an application in the Sandbox, you must obtain a set of keys for the Sandbox. Follow these steps to generate Sandbox keys.

  1. Go to the Walmart Developer Portal > API Keys Management page.
  2. Click on the Sandbox tab.
  3. Get your Sandbox authentication keys.

Sandbox Keys for Solution Providers (Delegated Access)

This is an optional feature to get keys for your Solution Providers to give them access.

  1. Log into the Walmart Developer Portal. Click My Account and enter your username and password. This takes you to API Keys page:
  2. Click SANDBOX KEYS.
  3. Click Add New Key For A Solution Provider, and select the provider name from the drop-down.
  4. Select access permissions and click Save.
  5. Get keys and share with your Solution Provider.

For more information about managing access levels and how delegated access works, see Delegated Access.

Throttling Limits

The throttling level has been set for the Sandbox API. If you try to exceed the limits, your API calls will be returned with an error: 429, “Too Many Requests”.

The following table represents the default throttling limits. If you encounter errors, contact Partner Support for assistance.

Feed Type Max Requests Max File Size per Call Processing Time per Request
Items
30 per hour
100KB
30 mins
Prices
30 per hour
5KB
30 mins
Promotion
30 per hour
25KB
30 mins
Inventory
30 per hour
2KB
30 mins
Lagtime
30 per hour
2KB
30 mins
Returns/Refunds
30 per hour
2KB
30 mins

Error Codes

The list of Error Codes for the Sandbox API is standard across the majority of the APIs, and requires that you go to the relevant API section to view the latest Error Code table. For a full list of error codes, see Marketplace Error Codes.

Sandbox FAQs

For a list of the latest FAQs, go to the Developer Portal Help.