List Itemsets
Use this API to list itemsets created in the advertiser account
Note: The API currently provides only a list of measurement itemsets that were successfully built
URL: POST/api/v1/itemsets/list
Request Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of the advertiser | integer | Y | Unique numeric identifier |
| Filter[itemsetId] | List of itemset IDs Note: max size of the array is 25 | array | N | Unique itemset IDs |
| Filter[lastModifiedDate] | To get list of itemsets modified on or after this date | date | N | date value. Date should be in format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| Filter[class] | To get list of itemsets belonging to a specific class | string | N | Enum values: • measurement • targeting |
| Filter[status] | To get list of itemsets belonging to a specific status | string | N | Enum values: • building • built • draft • failed • invalid • pending |
| startIndex | You can use this parameter to fetch specific number of itemsets from the available list. This indicates the starting position of the list | string | N | A range of 0 to length of the list minus one Example: To return the first ten itemsets entries, set startIndex=0 and count=10 |
| count | You can use this parameter in combination with startIndex to fetch specific number of itemsets from the available list. | integer | N | Number of itemsets that you want to fetch in response to this call Note: defaultCount=100, maxCount = 100, minCount = 1 Example: To return the first ten itemset entries, set startIndex=0 and count=10 |
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 |
| 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 more information |
| 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_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 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp. | Y | Use the signature generator code from Getting Started Guide to generate this value |
Sample Request
curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/itemsets/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, "Filter[itemsetId]": [1, 2], "Filter[lastModifiedDate]": "string", "Filter[class]": "measurement", "Filter[status]": "built", "startIndex": 0, "count": 10 } ' Response
| Element | Description | Type |
|---|---|---|
| totalResults | Total number of rows returned in the response | integer |
| itemsets | Elements of array:
| string |
Sample Response
{ "totalResults": 2, "itemsets": [ { "itemsetId": 1, "name": "string", "description": "string", "status": "BUILT", "class": "MEASUREMENT", "editable": "true", "creationDate": "string", "lastUpdatedDate": "string" }, { "itemsetId": 2, "name": "string", "description": "string", "status": "BUILT", "class": "MEASUREMENT", "editable": "true", "creationDate": "string", "lastUpdatedDate": "string" } ] } Updated 23 days ago