Get List Of Items

post

https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/items/list

This request to get the list of items available to user to build an itemset through an API.

Body Params

advertiserId

int64

required

Value should be greater than and equal to 0. Default 0.

startIndex

int32

Defaults to 0

Value should be greater than 0. Default 100.

count

int32

Defaults to 100

The brand identifier.

isRestricted

boolean

Defaults to true

filters for brand, category and subCategory are not supported when isRestricted = false

expandVariants

boolean

Defaults to false

Controls whether to expand results to include related variants when filtering by itemId or gtin.

filter[itemType]

string

enum

Allowed:

filter[itemId]

array of int64s

Supported 'exact' match

filter[itemId]

filter[itemName]

array of strings

Supported 'EXACT' match

filter[itemName]

filter[catalog]

string

enum

Allowed:

filter[gtin]

array of strings

Supported 'EXACT' match

filter[gtin]

filter[department]

array of strings

taxon1_name is department. Supported 'EXACT' match. Case insensitive

filter[department]

filter[category]

array of strings

taxon2_name is category. Supported 'EXACT' match. Case insensitive

filter[category]

filter[subCategory]

array of strings

taxon3_name is sub-category. Supported 'EXACT' match. Case insensitive

filter[subCategory]

filter[brandName]

array of strings

Supported 'EXACT' match

filter[brandName]

Responses

400

Invalid request parameters supplied

500

Internal Error

Language

Credentials

Response

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

application/json

200successful operation