List Items

📘
URL: POST/api/v1/items/list

Request Parameters

Parameters	Notes	Type	Required	Possible Values
advertiserId	ID of advertiser	integer	Y	Unique numeric identifier
isRestricted	Specifies whether to retrieve the list of items in own catalog or from all available items. *Note:* filters for brand, category and subCategory are not supported when isRestricted = false Default value of isRestricted is true filter[itemName] is mandatory if isRestricted = false	Boolean	N	Values: true false
filter[itemId]	ID of the item for which details are to be retrieved.	integer	N	Valid item IDs
filter[itemName]	Name of the item for which details are to be retrieved. Note: filter[itemName] is mandatory if isRestricted = false Supports 'exact' match	string	N	Valid item names
filter[catalog]	Specify to fetch list of items from online or store or universal catalog.	string	N	Enum Values: online: items sold online stores:items sold in stores universal: items sold both online and in stores
filter[gtin]	GTIN of the item for which item details are to be retrieved. Note: Supports 'exact' match	string	N	Enum Values: online: items sold online stores:items sold in stores universal: items sold both online and in stores
filter[department]	Specify to fetch list of items in the designated department Note: This parameter is case insensitive Supports 'exact' match	date	N	Valid department
filter[category]	Specify to fetch list of items in the designated category Note: This parameter is case insensitive Supports 'exact' match	string	This field is required only if it is not set at ad group level	Valid category
filter[subCategory]	Specify to fetch list of items in the designated sub-category Note: This parameter is case insensitive Supports 'exact' match	double	This field is required only if: -It is not set at ad group level -budgetType is set to be daily	Valid subcategory
filter[brandName]	Specify to fetch list of items in the designated brand Note: Supports 'exact' match	string	N	Valid brand name
startIndex	Use this parameter to fetch specific number of items from a list, in combination with count. This indicates the starting position of the list Note: Value of startIndex must be greater than and equal to 0. The default value is 0_	integer	N	Integer value Example: To return the first ten catalog items, set startIndex=0 and count=10
count	Defines the total number of items to be returned. You can use this parameter in combination with startIndex, to fetch specific number of items from a list. Note: Value of count must be greater than 0. The default value is 100	integer	N	Integer value Example: To return the first ten catalog items, set startIndex=0 and count=1

Note:
"The error message TOO_MANY_FILTERS_PROVIDED_IN_REQUEST is returned when too many filters are used and the request is not processed "

Headers


Header Name	Description	Required	Values
Authorization	The token will provide you the access to the API. It is same for all advertisers you access through the API	Y	Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide. This key can be repurposed for SP API access as well.
WM_CONSUMER.ID	We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.	Y	Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for further explanation on this
WM_SEC.AUTH_SIGNATURE	Auth signature as an API key	Y	Use the signature generator code from Getting Started Guide to generate this value
WM_CONSUMER.intimestamp	Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp	Y	Use the signature generator code (Getting Started Guide) to generate this value
WM_SEC.KEY_VERSION	We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API	Y	1

Sample Request


curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/items/list' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <auth_token>'
--header 'WM_SEC.AUTH_SIGNATURE: **************' \ --header 'WM_SEC.KEY_VERSION: 1' \  --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779' --data '{ "advertiserId": 1, "isRestricted": true, "filter[itemId]": [29799], "filter[itemName]": ["Planner Datebook"], "filter[catalog]": "online", "filter[gtin]": ["0062"], "filter[department]": ["Office"], "filter[category]": ["Calendars"], "filter[subCategory]": ["Planners"], "filter[brandName]": ["brandName"], "startIndex": 0, "count": 5 }'

Response

Element	Description	Type
code	The response code can have following values: • success • failure	string
details	Details will populate an error message in case of code=failure	string
totalResults	Total number of rows returned in the response	integer
data	data will populate details of items, retrieved through request if code is success catalog:Type of catalog of the returned item indicates whether the item is sold online, in-store, or through both channels ONLINE - items sold online STORE - items sold in store UNIVERSAL - items sold both online and in store. For using these items in itemsets, use the item's GTIN in the itemset create/update calls itemId: Id of the returned item gtin: gtin of the returned item itemName: Name of the returned item imageUrl: URL of item image itemPageUrl: URL of item page brandName: brand to which the item belongs department: Department under which the item is classified category: category under which the item is classified subCategory: subcategory under which the item is classified

Sample Response

{ "code": "success", "totalResults": 1, "data": [ { "catalog": "ONLINE", "itemId": 1, "gtin": "1", "itemName": "itemName", "imageUrl": "imageUrl", "itemPageUrl": "itemPageUrl", "brandName": "brand", "department": "department", "category": "Personal Organizers", "subCategory": "Planners & Appointment Books" } ]
}

Note: Please use 'GTIN' as the "itemType" in the call POST api/v1/itemset (hybrid expression), if the type of catalog is "UNIVERSAL"_

📘URL: POST/api/v1/items/list

Request Parameters

Headers

Sample Request

Response

Sample Response

📘
URL: POST/api/v1/items/list