Token API

This endpoint issues access tokens required for authenticating API requests. It supports multiple OAuth 2.0 grant types to accommodate various integration scenarios.

Market availability: Global

Supported Grant Types

Grant TypeDescriptionHow to get the credentials
authorization_codeExchanges an authorization code for an access token.Used in app integration only via the OAuth consent screen. This is applicable to the US market only. Refer to OAuth 2.0 authorization for more details.
client_credentialsIssues a token using client ID and secret.For sellers: Obtain client_id and client_secret from the Developer Portal.
For solution providers: Obtain credentials from sellers via Delegated Access authorization.
refresh_tokenIssues a new access token using a refresh token.Provided during the authorization_code flow. This is applicable to the US market only. Refer to OAuth 2.0 authorization for more details.

Note:
Use authorization_code and refresh_token only for app-based integrations. These grant types are currently supported only in the US market.

Token Lifetimes

Token TypeDuration
Access Token15 minutes (900 seconds)
Refresh Token1 year (365 days)
Form Data
string
enum
required
Defaults to client_credentials

Type of grant requested.
Available grant types: authorization_code, refresh_token and client_credentials

Market availability: Global

Allowed:
string
Defaults to 65CA5DA313A549D49D15D3119D9AD85D

Authorization code obtained by your client app when the seller authorizes your app to access the seller resource.
This field is required when grant_type: authorization_code

Market availability: Global

string
Defaults to https://example-client-app.com

This should be same as one of your client app URIs provided while registering the app.
This field is required when grant_type: authorization_code

Market availability: Global

string
Defaults to APXcIoTpKMH9OQN.....

Refresh token received as response of Authentication API with authorization_code grant type, to be used to refresh the access token. The token lifetime is 1 year.

Market availability: Global

Headers
string

Partner Id registered in Walmart marketplace to identify a seller.
This field is required when grant_type: authorization_code and grant_type: refresh_token

Market availability: Global

string
required

Available marketplace location: us (USA), mx (Mexico), ca (Canada) or cl (Chile)

Market availability: Global

string
required

Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.

Market availability: Global

string

A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding.

Market availability: Global

string
required

A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID

Market availability: Global

string
required

Walmart Service Name

Market availability: Global

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/xml