Overview

The Entity match API gives Payout Service Providers (PSPs) access to seller entity data. Use it to retrieve key matching details, including the seller’s business identifier, legal business name, and country of incorporation. Depending on the country, the business identifier may be a registration number or tax identifier. Use this API to verify seller information and support compliant payment processing.

Authentication varies by market:

US: PSPs use OAuth 2.0 seller authorization via the App Store
Canada (CA): PSPs use delegated access authorization.

Entity profile data includes the seller’s business identifier (for example, business registration number or tax identifier depending on country), legal business name, and the country of incorporation. This API can be used by Payout Service Providers (PSPs) to validate if a seller's entity details match during onboarding and payout processes.

Leverage this API to ensure that the seller's information is accurate and compliant, minimizing payment exceptions, and facilitating timely and lawful payment transactions.

Endpoint

GET /v3/settings/entitymatchprofile

Function

Retrieves seller entity data, such as business identifier (registration number or tax identifier), legal business name, and Country of Incorporation (COI)
Access is restricted to select PSPs only
Allows PSPs to view data for sellers who have authorized the PSP, authenticated using an access token

Prerequisites

Complete the following before you start integrating with the Entity match API:

Seller must authorize PSP access to the Entity match API.
PSPs must be authorized to access the Entity match API.
PSP must obtain necessary access tokens through the Token API and authenticate using those tokens to access the Entity match API.

Sample request

curl -X GET "https://marketplace.walmartapis.com/v3/settings/entitymatchprofile" \ -H "WM_SEC.ACCESS_TOKEN: your_access_token" \ -H "WM_CONSUMER.CHANNEL.TYPE: your_channel_type" \ -H "WM_QOS.CORRELATION_ID: your_correlation_id" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_MARKET: us" \ -H "WM_GLOBAL_VERSION: 3.1" \ -H "Accept: application/json"

import requests url = "https://marketplace.walmartapis.com/v3/settings/entitymatchprofile" headers = { "WM_SEC.ACCESS_TOKEN": "your_access_token", "WM_CONSUMER.CHANNEL.TYPE": "your_channel_type", "WM_QOS.CORRELATION_ID": "your_correlation_id", "WM_SVC.NAME": "Walmart Marketplace", "WM_MARKET": "us", # Allowed values: us, ca "WM_GLOBAL_VERSION": "3.1", # The version of the global API used "Accept": "application/json"
} response = requests.get(url, headers=headers) print(response.status_code)
print(response.json())

Modify your code

Use your WM_SEC.ACCESS_TOKEN obtained from the Token API.
Use your WM_QOS.CORRELATION_ID for each request to track and correlate requests and responses across systems.
Provide WM_SVC.NAME to specify the Walmart service being called.
Set WM_MARKET to the target market for the API call. Allowed values: us, ca.
Set WM_GLOBAL_VERSION to the global API version your integration is targeting. Allowed value: 3.1.
Provide WM_CONSUMER.CHANNEL.TYPE if supplied during onboarding to identify the consumer request by channel (optional).

Sample response

{ "body": { "businessRegistrationNumber": "ABCD0050", "name": "Collins Goods LLC", "countryOfIncorporation": "HK" }, "status": "OK"
}

Errors and remediation

HTTP status	When it happens	What to do (remediation)
404 Not Found	Entity profile data is not available for the seller context (for example, tax information is missing/not on file, or the partner context cannot be found).	Confirm the seller has completed required tax/entity setup. Verify the seller has authorized your PSP to access entity match data using the applicable authorization method for the market. US: PSPs use OAuth 2.0 seller authorization via the App Store Canada (CA): PSPs use delegated access authorization. Retry after the seller updates their entity/tax information. If it persists, capture. If it persists, capture `WM_QOS.CORRELATION_ID` and contact Walmart support with the correlation ID and timestamp.
500 Internal Server Error	A temporary server-side error occurred while processing the request.	Retry with exponential backoff and jitter. If the error persists, capture `WM_QOS.CORRELATION_ID`, timestamp, and request details, then contact Walmart support.
429 Too Many Requests	Too many requests sent in a short period; throttling triggered.	Implement retries with exponential backoff and jitter. Reduce burst rate and cache responses when possible. Follow the Rate limiting guide throttling recommendations.

Result

If successful, the API response returns an HTTP status: 200 OK with a JSON payload containing the matching entity data of the seller, including:

businessRegistrationNumber: Seller business identifier (for example, business registration number or tax identifier depending on country).
name: The seller’s legal business name.
countryOfIncorporation: The country in which the business is legally incorporated/registered.

Next steps

The Get shipping template details API gives you specific shipping configurations for a single shipping template.

The Update shipping templates API lets you modify configurations on an existing shipping template, such as shipping methods, regions, transit times, and pricing rules.

The Delete shipping templates API lets you permanently remove existing shipping templates from Walmart Marketplace settings.

The Get all fulfillment centers API retrieves fulfillment centers (also known as ship nodes) information on your account.

The Update fulfillment center API helps you update your existing fulfillment centers (also known as a ship nodes) configuration in Marketplace Settings.

The Create fulfillment center API sets up new fulfillment centers (also known as ship nodes) in Walmart Marketplace Settings.

The Get account level settings API retrieves account-level shipping settings such as calendar day configurations, weekends, and additional days off.

The Update account level settings API allows you to configure account-level calendar settings that impact shipping calculations and delivery promise logic.

The Create account level settings API lets you establish account level calendar configuration for your shipping operations.

The Get all shipping templates API retrieves a list of all shipping templates configured on your account.

The Create shipping templates API allows sellers to create custom shipping templates that define shipping methods, transit times, pricing logic, and geographic coverage.

The Third-party fulfillment center association API allows sellers to activate or update the status of 3PL (third-party logistics) ship nodes associated with your Marketplace account.

The Get shipping configurations API retrieves account-level shipping profile settings associated on your account.

The Get shipping template activation status API allows sellers to retrieve the current activation state of shipping templates at the account level.

The Get coverage for fulfillment centers API retrieves the geographic coverage areas associated with each fulfillment center (ship node) configured under a seller account.

The Get carrier methods API retrieves the list of carrier methods available for use in Marketplace shipping configurations

The Get all third-party fulfillment providers API retrieves all third-party fulfillment providers (3PLs) available on the Walmart marketplace.

The Get partner configurations API retrieves seller-level profile information and system configuration settings associated with a Marketplace partner account.