API Reference

List Itemsets

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

Use this API to list Measurement (Featured and Halo) and Targeting itemsets created in the advertiser account.

Body Params
integer
required

ID of the advertiser.

integer

You can use this parameter to fetch specific number of itemsets from the available list. This indicates the starting position of the list.
The default value is 0.

integer

You can use this parameter in combination with startIndex to fetch specific number of itemsets from the available list.
The default value is 100.

Filter[itemsetId]
array of integers

List of itemset IDs.
The maximum number of itemset IDs that can be provided in the list is 25.

Filter[itemsetId]
string
enum

To get list of itemsets belonging to a specific status.

Allowed:
string
enum

Specifies whether to return itemsets that are either owned by the advertiser or shared with them.

Allowed:
string
enum

To get list of itemsets belonging to a specific class.
Note: Currently, only targeting item sets can be shared via Walmart ad center.

Allowed:
date-time

To get list of itemsets modified on or after this date.

Headers
string
required

Auth signature as an API key.

string
required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

integer
required

We will provide you with the KEY VERSION to access the API.
It is same for all advertisers you access through the API. The allowed value is 1.

integer
required

Timestamp for which the auth signature is generated. Use Unix epoch format.

string
required

This is bearer token.
The token will provide you the access to the API. It is same for all advertisers you access through the API.

Responses

Updated about 7 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 7 hours ago

Did this page help you?