Retrieve all items

get https://api-gateway.walmart.com/v3/items

This request displays a list of all items.

If the complete number of items exceeds the limit of items returned in a single request, the full list can be retrieved by subsequent requests using the nextCursor pagination mechanism.

If a stock keeping unit (SKU) is included in the request as a query parameter, the response will only return the SKU in redefined format.

Query Params

nextCursor

string

Defaults to *

Specifies the value used for paginated results when more than 200 items are retrieved.

Use the nextCursor response element from the prior API call. The value of the response includes a link to another GET call which retrieves the next page of results.

Example:

sku

string

Specifies the stock keeping unit (SKU) item identifier.

This type of identifier is specified by the drop ship vendor (DSV) and used by the vendor in the specification file to refer to each item.

Example:

RG-IRAE-79VD

publishedStatus

string

Specifies the published status of an item, describing where the item is in the submission process.

Valid values are:

Value	Meaning
INPROGRESS	The item is still in the submission process and a publishing decision has not yet been made.
PUBLISHED	The item has been accepted and is published.
UNPUBLISHED	The item is not available on the site. It has either been rejected during the submission process or removed from the site.

Example:

PUBLISHED

INPROGRESS

Headers

string

Specifies the data type expected in a response sent from the server.

Valid values are:

Value	Meaning
application/json	JSON format for data returned in response.
application/xml	XML format for data returned in response.

WM_CONSUMER.CHANNEL.TYPE

string

Specifies an identifier that tracks the consumer request by channel.

Use the consumer channel type received during onboarding.

Contact the system administrator or developer management for the WM_CONSUMER.CHANNEL.TYPE value.

WM_QOS.CORRELATION_ID

string

required

Specifies an identifier for each API call and is used to track and debug issues.

This may be any value, but cannot be null or omitted.

WM_SEC.ACCESS_TOKEN

string

required

Specifies the access token retrieved in the Create Access Token request.

This value is required for token-based authentication.

Responses

Response body

object

itemResponse

array of objects

required

Indicates items included in the response list.

itemResponse*

object

mart

string

Indicates the marketplace name.

Example:

WALMART_US

WALMART_US WALMART_CA ASDA_GM WALMART_MEXICO

sku

string

Indicates the stock keeping unit (SKU) item identifier.

This value is specified by the drop ship vendor (DSV) and used by the vendor in the specification file to refer to each item.

Example:

RG-IRAE-79VD

wpid

string

Indicates the Walmart product identifier (WPID) item identifier.

This value is an alphanumeric product identifier that is generated by Walmart.

Example:

434K5CFOY8G7ZZZ

upc

string

Indicates the Universal Product Code (UPC) item identifier.

This value is a 12-digit barcode used extensively for retail packaging in the United States.

Example:

889296686590

gtin

string

Indicates the global trade item number (GTIN) compatible item identifier.

These values include Universal Product Code (UPC) and European Article Number (EAN). UPCs must be 12 or 14 digits in length. EANs must be 13 digits in length.

Example:

00012345678905

productName

string

Indicates a seller-specified, alphanumeric item identifier that identifies the product name.

Example:

Sterling Silver Blue Diamond Heart Pendant with 18in Chain

shelf

string

Indicates the Walmart-assigned item shelf name.

Example:

Home Page

productType

string

Indicates a seller-specified, alphanumeric item identifier that identifies the product type.

Example:

Diamond

price

object

publishedStatus

string

Indicates the published status of an item, describing where the item is in the submission process.

Valid values are:

Value	Meaning
INPROGRESS	The item is still in the submission process and a publishing decision has not yet been made.
PUBLISHED	The item has been accepted and is published.
UNPUBLISHED	The item is not available on the site. It has either been rejected during the submission process or removed from the site.

Example:

PUBLISHED

INPROGRESS

unpublishedReasons

object

Indicates an object for unpublished reasons.

Fields within this object outline the reason an item is unpublished. Unpublishing occurs when publishedStatus is set to UNPUBLISHED.

UNPUBLISHED is when the item page is not published or visible to users on Walmart.com.

lifecycleStatus

string

Indicates the lifecycle status of an item describes where the item listing is in the overall lifecycle.

Valid values are:

Value	Meaning
ACTIVE	Indicates an active lifecycle status.
ARCHIVED	Indicates an archived lifecycle status.
RETIRED	Indicates a retired lifecycle status.

Example:

ACTIVE

ACTIVE ARCHIVED RETIRED

totalItems

int32

Indicates the total number of items for the query.

Example:

12

nextCursor

string

Indicates the value used for paginated results when more than 200 items are retrieved.

Use the nextCursor response element from the prior API call.
The value of the response includes a link to another GET call which retrieves the next page of results.

Example:

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-gateway.walmart.com/v3/items \
3
     --header 'accept: application/json'

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

application/json

200Successful Operation

401Unauthorized