Market-specific to Global API mapping

Introduction

This guide explains how market-specific legacy Marketplace APIs map to Global partner APIs across supported markets. The mapping also identifies capabilities introduced for one or more markets through Global partner APIs.

Refer to the Global partner API market capability mapping spreadsheet as the source of truth for market-to-Global API mapping decisions. The spreadsheet file name includes the upload date to help identify the latest version.

Global partner API - Market capability mapping

When this is useful

Use this mapping when you are:

• Planning a migration from market-specific integrations to Global partner APIs
• Determining whether you can standardize an integration across markets
• Checking whether a legacy market-specific API has a Global API equivalent
• Identifying APIs or capabilities introduced through Global partner APIs
• Planning how to handle legacy APIs that do not have an active Global API equivalent

What’s in the spreadsheet

The workbook is organized by market and includes:

• Market-specific API details: Market, API category, API name, method, and endpoint
• Global mapping: The corresponding Global API category, name, and endpoint, when available
• Availability indicator: Whether a legacy API is available in Global
• New in Global: APIs introduced to one or more markets through Global partner APIs, including the markets where they are new and their availability by market

How to read the mapping

Use each market tab to compare market-specific legacy APIs with the corresponding Global partner APIs, when available. Each row includes the legacy API details, Global availability status, and mapped Global API details.

The New in Global tab lists APIs introduced for one or more markets through Global partner APIs and shows their availability across Canada, Chile, Mexico, and the US.

All API endpoints in the spreadsheet use https://marketplace.walmartapis.com as the base URL unless otherwise specified.

Keep the following in mind when reviewing the mapping:

• Global availability indicates whether an active matching Global partner API is identified in the mapping. Yes means a Global partner API equivalent is listed. No means no active Global partner API equivalent is identified; review the Global mapping columns for any additional status information.
• Endpoint paths may differ between legacy and Global partner APIs. Review the mapped Global API name and endpoint before migrating.
• Some legacy APIs may be decommissioned or replaced by a different Global partner API workflow.

How to use it

Use this mapping to identify the correct Global API, then open the relevant API reference to validate implementation details before making integration changes.

1. Select the applicable market tab, such as USA - Legacy to Global, Canada - Legacy to Global, Mexico - Legacy to Global, or Chile - Legacy to Global.

2. Find the legacy endpoint your integration uses today.

3. Check the Global availability column.

   • If the API is marked Yes, use the mapped Global API listed in the Global mapping columns.
   • If the API is marked No, review the Global mapping columns for deprecation or other migration information before deciding how to update the integration.

4. Review the New in Global tab to identify APIs introduced to one or more markets through Global partner APIs and confirm their availability by market.

5. Open the relevant Global API reference to confirm request and response schemas, required headers, parameters, permissions, workflow behavior, market-specific requirements, and error responses.

Notes and limitations

The mapping is intended as a functional reference. Feature availability varies by market. In some cases, the mapped Global API may differ from the market-specific legacy API in request and response structure, required headers, parameters, permissions, supported workflows, feature flags, market-specific behavior, or error responses.