Token API

post

https://marketplace.walmartapis.com/v3/token

Obtain access tokens for API authentication using OAuth 2.0 by providing Client ID and Client Secret. This endpoint supports multiple grant types for different authentication scenarios - Client Credentials Grant, Authorization Code Grant, Refresh Token Grant.

An access token expires after a certain interval, so you will have to refresh a user's access token. You could use refresh token, obtained from the token API call using authorization code grant type, to get a new access token. Token Lifetimes

Access Token: 15 minutes (900 seconds)
Refresh Token: 1 year (365 days)

Get an access token using Token API

Get started as a seller

Get started as a solution provider

OAuth2.0 authorization

Form Data

grant_type

string

enum

required

Defaults to client_credentials

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

Allowed:

code

string

Defaults to 65CA5DA313A549D49D15D3119D9AD85D

Authorization code returned to your redirect URI, 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.

redirect_uri

string

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

Redirect URI must exactly match one of the URIs registered for your client app, which was provided while registering the app.
This field is required when grant_type: authorization_code.

refresh_token

string

Defaults to APXcIoTpKMH9OQN.....

Refresh token received as response of Authentication API with authorization_code grant type. Use it to exchange for a new access token when the current one expires.
This field is required when grant_type: refresh_token.

Headers

WM_PARTNER.ID

string

Partner ID registered in Walmart marketplace to identify a seller account.
This field is required when grant_type is authorization_code or refresh_token.

Authorization

string

required

Use a Basic Authorization header by Base64-encoding the Client ID and Client Secret obtained in step two of the integration process. Format the credentials as ClientID:ClientSecret before encoding.

Content-Type

string

required

Content type of the request body.

WM_CONSUMER.CHANNEL.TYPE

string

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

WM_QOS.CORRELATION_ID

string

required

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

required

Specifies the name of the Walmart service being called.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

200Successful Operation