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 latest 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.

Review the Global Marketplace API overview first, and then use this mapping to identify the corresponding Global APIs and any migration considerations for your existing workflows.

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
  • Identifying mappings that require additional migration considerations

What’s in the spreadsheet

The workbook includes mapping tabs for Canada, Mexico, and Chile, along with a New in Global tab.

The market-specific tabs show legacy API details, corresponding Global API details when available, availability in Global, and migration guidance when applicable.

The New in Global tab includes:

  • Global API category, name, method, and endpoint
  • The market where each API is new
  • Availability across Canada, Chile, Mexico, and the US
  • Migration guidance, when applicable

How to read the mapping

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

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

The Legacy API Endpoint and Global API Endpoint cells link to the corresponding API references, when available. All API endpoints use https://marketplace.walmartapis.com as the base URL unless otherwise specified.

ColumnDescription
MarketMarketplace where the legacy API is available.
Legacy API CategoryFunctional category for the legacy API.
Legacy API NameName of the legacy API operation.
Legacy API MethodHTTP method used by the legacy API. Compare it with the Global API method before migrating.
Legacy API EndpointLegacy API endpoint and link to its reference, when available.
Available in GlobalIndicates whether a Global API equivalent is available.
  • Yes means an active equivalent is identified.
  • No means no active equivalent is identified; review the Global mapping columns for deprecation or other status information.
  • Yes - Migration considerations apply; review the Migration Guidance column means a Global mapping exists, but additional implementation considerations apply.
Global API EndpointMapped Global API endpoint and link to its reference, when available. The endpoint may differ from the legacy endpoint.
Global API NameName of the mapped Global API operation.
Global API CategoryFunctional category for the mapped Global API.
Global API MethodHTTP method used by the mapped Global API. The method may differ from the legacy API method.
Migration GuidanceAdditional implementation or workflow considerations, when applicable.

How to use it

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

  1. Select the applicable market tab: 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 Available in Global column and follow the guidance for the applicable status.
  4. Compare the legacy and Global API methods, names, categories, and endpoints.
  5. Review the New in Global tab to identify APIs introduced for one or more markets through Global partner APIs and confirm their availability by market.
  6. Open the linked API references from the Legacy API Endpoint and Global API Endpoint columns 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. Some legacy APIs may be decommissioned or replaced by a different Global partner API workflow. In some cases, the mapped Global API may differ from the market-specific legacy API in request and response structure, HTTP method, endpoint, required headers, parameters, permissions, supported workflows, feature flags, market-specific behavior, or error responses.

Review the Migration Guidance column and the relevant API reference before making integration changes.

.


Did this page help you?