US FAQ

Who can use the Marketplace API Sandbox?

The target audience is Marketplace Sellers who are onboarded to sell items on Walmart.com and are integrating their apps with new or existing APIs.

What is the Marketplace API Sandbox?

The Marketplace API Sandbox provides a test environment for sellers to test APIs before they push to production to ensure a successful integration.

How can I access the API Sandbox? How is it different from production APIs?

When you create your API keys in the developer portal, you can also create sandbox API keys.

Marketplace APIs will have new Sandbox-only URLs alongside the standard production URLs. The samples, error codes and reports will be the same as the production APIs.

How can I get my Sandbox API authentication keys?

When you log into the Walmart Developer Portal, it takes you to the API Keys for Production and Sandbox. For more details, see Authorization.

Are there requirements to use the Sandbox?

Yes, make sure you are using the Item Specification version 3.

What are the benefits and scope of the Sandbox?
The benefits to using the Sandbox include:
  • Access simulation APIs that you can call from your applications, in realtime, to test the integration process.
  • 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 without hindering project timelines.
  • Try out new features and provide feedback before changes are pushed to production.
The scope of the sandbox environment includes:
  • Marketplace APIs
  • API request and response validation
  • Spec validation
  • Mock responses
  • Throttling limits
  • Error codes
  • Delegated Access
Are there any restrictions to use Sandbox APIs compared to Production APIs?
  • The items will not be seen on Walmart.com.
  • Sandbox environment is NOT a full stack staging environment so partners will not be able to do end-to-end testing.
  • Responses are based on mock data.
What is Marketplace Free 2-Day Shipping
  • The program offers qualified sellers a way to offer Free 2-day Shipping to our customers, with dynamic, location-based logic that will automatically display the Free 2-Day Shipping tag on eligible items.
  • Key features of this program are designed to provide sellers with increased product visibility, Buy Box prominence, and regional shipping settings.
  • For more information visit: SellerHelp Walmart
How can I give Solution Providers their own API Keys?

As a seller, you can create separate API keys for each Solution Provider. Just log into the portal, and the API Keys page: developer.walmart.com/generateKey. Just click “Add New Key for a Solution Provider” to create credentials for them, including Client ID and Client Secret. You can now share these credentials with your Solution Provider.

Some best practices we recommend:

  • Seller should generate separate keys for each solution provider and should not share keys between the providers.
  • Don’t give your API directly to Solution Providers.
  • To learn more about delegated access, see Authorization.
What kind of authentication do you provide for API keys?

We provide OAuth authentication via Client ID and Client Secret. Sellers can get their API Keys with Client ID and Client Secret authentication.

We also provide delegated access, so sellers can create separate API keys for their Solution Providers.

 

I’m a seller with full access to APIs. Why am i getting “unauthorized” error?
  • Please check that you have recent credentials. Log into the portal and verify your Client ID and Client Secret are active.
  • Credentials are assigned for the Partner, which will be shared within all the users within the Partner. Make sure someone else has not reset the keys.
  • If you continue to experience issues, please contact Walmart support.
I have the correct credentials, and an access token. Why am I getting “unauthorized” error?
  • OAuth assigns a scope of access for each set of client credentials. Depending upon the scope of the keys, Walmart will allow, or reject, certain API calls.
  • Seller credentials (which are on API keys page) have full access. The seller is authorized to make all API calls and there are no restrictions.
  • By default, keys generated for a Solution Provider have no access and are not authorized to make any API calls at the start. You need to go in and assign permissions per object category (e.g. Items, Orders).
How can I reset my Client ID and Secret?

When you log into the Developer Portal, it takes you to the Production Keys and Sandbox Keys.

You need Admin access to reset the Client ID/Client Secret.

When you reset the credentials, save both the Client ID and Client Secret because so you need them both to get the access_token.

Do I need to store the Client Secret locally?

No. With this new feature you can get the Client ID/Client Secret anytime on the Developer Portal, so you no longer have to keep the secret locally and regenerate if lost.

Where can I get my API Keys?

When you log into the Developer Portal, it takes you to the Production Keys and Sandbox Keys authentication area, where you can set your Client ID and Client Secret.

You can get there directly: https://developer.walmart.com/generateKey.

Is the Client ID and Client Secret the same as Consumer ID and Private Key?

No. Client ID/Client Secret is different from Consumer ID/Private Key combination. Consumer ID/Private Key was required for the old authentication method. With oAuth you will have to use only the ClientID/Client Secret that you can get from Developer Center.

How does the header change for APIs?
  • To learn more about the API Headers for the GET token API, see Authentication.
  • For all other API headers:
    • Remove these header parameters: WM_SEC.TIMESTAMP, WM_SEC.AUTH_SIGNATURE, WM_CONSUMER.CHANNEL.TYPE, WM_CONSUMER.ID
    • Add for Authorization, this header parameter: WM_SEC.ACCESS_TOKEN
    • For more details, refer to the Reference for each API, (e.g. GET All Feed Statuses).

After the headers are updated, you will use the access_token to make subsequent API calls.

What is OAuth Authentication?

OAuth 2.0 is the industry standard for token-based authentication and authorization for APIs.

Learn more about OAuth at https://oauth.net/2/.

How can I get to the Analytics Dashboard?

You need to log into the Walmart Developer Portal with your credentials to see the Analytics Dashboard. It provides a custom view for each seller to see their own API success rates and errors per object group.

  1. Go to developer.walmart.com and select My Account.
  2. Select Marketplace and enter your credentials.
  3. Select API Analytics in the left pane.

How can I view the success rate of my APIs?

You can view the success rates as a percentage of successful API calls for each API group (e.g. Items, Promotions, Orders) with the Analytics Dashboard.

  1. Select which API group you want to view in the graph.
  2. Select a date range to view, with start and end date.
  3. Select a time period Daily, Weekly, or Monthly.

The graph displays success rate for each API group you selected as a function of the time period you selected.

How can I view how many errors are 400, or 500 error type?

For each API object group, you can filter the percentage of errors by error type.

Use the Error drop-down to specify which error type you want to view percent errors.

In the object group, (e.g. Items), look at the API Errors column. This shows you the percentage of errors that this API group has for the error type selected, (e.g. 400 errors).

If Items shows 19.59%, this means that for all Item errors, 19.59% are due to 400 error type.

 

 

Why does my get Feed Status API return a 404 error?

Walmart stores the feed information for a limited period of time, depending upon the feed type. If you call the feed status API outside of the retention time, you will get a 404 feed status error.

These are the retention days per FeedType:

Item 22 days

Price 25 days

Lag Time 25 days

Item Overrides 25 days

Promotions 25 days

Item Retire 25 days

 

What are the most common Lag Time errors?

Most common lag time feed errors are due to category-based lag time exceptions that are not approved for the particular category. To avoid these errors, you can revert asking to grant the approval, enable longer ship times or remove the lag time option for your SKUs.

Due to the current Covid-19 situation, some sellers add a few days as a buffer for their lag times. This causes some of their items to go over the allowed lag time, resulting in errors.

Why does a service provider get 404 errors for a seller’s items?

If a service provider has a different SKU for an item than the one that a seller has added, they will get 404 errors.

Two possible reasons for an Item 404 error:

Seller has a different SKU integrated for that item than the SKU that the service provider has.

Seller did not add that Item SKU to their Walmart catalog.

 

I am using Version 3.1 and need to enable the Free 2-Day Shipping feature. What do I need to do?
  1. Populate the mandatory parameters: Price, Product TaxCode, and Shipping Weights.
  2. Ensure the following element (marked in RED) is present in the payload, along with relevate states (marked in BLUE):


<ShippingProgramOverrides>
<shippingProgramOverride>
<twoDayShippingOverride>Yes</twoDayShippingOverride>
<twoDayShippingRegion>STREET_48_STATES</twoDayShippingRegion>
<twoDayShippingWestRegionStates>AZ,CO,ID,NM,MT,UT,NV,WY,CA,OR,WA</twoDayShippingWestRegionStates>
<twoDayShippingNortheastRegionStates>CT,ME,MA,NH,RI,VT,NY,NJ,PA</twoDayShippingNortheastRegionStates>
<twoDayShippingMidwestRegionStates>IN,IL,MI,OH,WI,IA,KS,MN,MO,NE,ND,SD</twoDayShippingMidwestRegionStates>
<twoDayShippingSouthRegionStates>DE,DC,FL,GA,MD,NC,SC,VA,WV,AL,KY,MS,TN,AR,LA,OK,TX</twoDayShippingSouthRegionStates>
</shippingProgramOverride>
</ShippingProgramOverrides>

  • twoDayShippingOverride is the final override flag value that determines the payload from FeedGateWay. If this is missing, no “TwoDayShipping” information will be passed.
How do I get started?
Register to get your API Key

To get your API key, you need to register as a Marketplace Seller, Supplier, Solution Provider or Content Service Provider:

1. Fill out the registration form.
Solution Provider:
https://marketplace.walmart.com/channel-partner-prospect-form/ and work with your seller to get your delegated access keys.
Supplier or Drop Ship Vendor: http://corporate.walmart.com/suppliers/apply-to-be-a-supplier
Marketplace Sellers: http://seller.walmart.com login to the seller center to get your Client ID and Client Secret.
Content Service Providers: send an email to: CSPSupport@wal-mart.com.
2. You will receive your portal login credentials after registration.
3. Login to the Developer Portal to get your API keys.
How do I integrate my application with the platform?
Integrate Your Application with Item Management APIs

Use the API Explorer page to test the APIs. Integrate your application with the item management platform by calling the item management APIs.
For setting up an item, use the provided XSDs to build an XML payload to ingest item feeds.

How can I test out my APIs? Do you have a test environment?

Yes! Use 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.