Global API migration FAQ
Migration
Is migration to the Global Marketplace APIs mandatory?
- United States (US): No. Existing integrations using the current US APIs will continue to operate without changes. However, you may choose to adopt the Global Marketplace APIs for your US integrations.
- Canada, Mexico, and Chile: Yes. Migration is required for these markets. The legacy country-specific APIs for Canada, Mexico, and Chile will be decommissioned. To avoid service disruption, integrations must migrate to the Global Marketplace APIs.
Why should sellers and approved Solution Providers with Canada, Mexico, and Chile integrations migrate to the Global Marketplace APIs?
The Global APIs provide a single integration that works across multiple markets.
All new features and enhancements are released only on the Global APIs. We are standardizing the authentication and authorization (token based authentication) across all markets.
How do I map my market-specific legacy APIs to the Global APIs during migration?
Refer to the Market-specific to Global API mapping guide. It includes a spreadsheet that maps market-specific legacy APIs to the corresponding Global APIs and highlights Global-only capabilities.
Will my existing US API integrations be affected if I migrate to the Global Marketplace APIs?
No. Existing US API integrations will continue to run without disruption. Migration to the Global Marketplace APIs for the US market is optional, and current US integrations will continue to work without changes.
What happens to existing Canada, Mexico, or Chile integrations?
They must migrate to Global APIs.
Existing integrations will continue to function until a decommission date is announced.
Multi-market integrations
Can I reuse my US integration to sell in Canada, Mexico, or Chile?
Yes. After completing onboarding for the new market, you can reuse your existing US integration to sell in Canada, Mexico, or Chile.
To support additional markets:
- Use the same Global Marketplace API endpoint.
- Include the appropriate market code in the
WM_MARKETheader (for example, CA for Canada). - Use Global API version 3.1 in the
WM_GLOBAL_VERSIONheader. - Ensure that you review the Global Marketplace API documentation and update your integration for any market-specific request and response attributes. For more details, refer to the Walmart Marketplace API Reference.
Are the Global APIs backward compatible with the current US APIs?
Yes.
Does access to one market automatically enable others?
No. You must complete onboarding for each additional market before transacting.
Authentication and credentials
The following table lists the required headers.
| Header | Type | Required | Description | Allowed values |
|---|---|---|---|---|
WM_SEC.ACCESS_TOKEN | string | Yes | Access token obtained from the Token API. Required for authenticating requests to Walmart Marketplace APIs. | — |
WM_CONSUMER.CHANNEL.TYPE | string | No | A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding. | — |
WM_QOS.CORRELATION_ID | string | Yes | A unique ID that identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID. | — |
WM_SVC.NAME | string | Yes | Specifies the name of the Walmart service being called. | — |
WM_MARKET | string | Yes | The target market of the API call. | us, ca, mx, cl |
WM_GLOBAL_VERSION | string | Yes | The version of the Global Marketplace API used. | 3.1 |
Can I keep using my existing client ID and secret?
The client ID and client secret requirements vary depending on the integration model and user persona.
| User persona | Credential behavior |
|---|---|
| Direct seller | The same client ID and secret can typically be used after onboarding into additional supported markets. |
| Approved Solution Provider | Each seller must authorize or provide credentials for each market they operate in. New market onboarding may require new API credentials for that seller and market. |
| App Store integrations | Existing US App Store credentials continue to work for current US integrations. |
| US integrations expanding to additional markets | Market-specific onboarding and credentials may be required depending on the integration model and market. |
- US expanding to other markets: Use the new client ID and secret issued for each market, as each market has its own client ID and secret for approved Solution Providers.
- US App Store integrations: Existing US credentials can continue to be used.
Documentation
Where is the Global API documentation?
The Global Marketplace API documentation is available in the Walmart Marketplace Developer Portal:
https://developer.walmart.com/global-marketplace
Canada (CA)
Canada integrations require migration and new API keys.
Is migration required for Canada?
Yes. All Canada integrations must migrate to the Global Marketplace APIs.
What happens to existing Canada integrations?
They must be migrated to the Global APIs.
Existing integrations will continue to function until a decommission date is announced.
Can existing API credentials be reused?
No. New API keys must be generated in the Developer Portal under API keys.
Can I use the same integration used for the US in Canada?
Yes. After onboarding, you can use the same endpoint by specifying the market code (CA) and API version 3.1. Be sure to review the API documentation and update your integration to accommodate any Canada-specific request or response attributes. For more details, refer to the Walmart Marketplace API Reference.
Do I need separate onboarding for Canada?
Yes. Access to the US marketplace does not automatically grant access to Canada.