Itemsets Info
Use this API to retrieve the list of items or brands added to an itemset
This API returns a list of items for the following itemset types:
Item, Category, and Hybrid
For Brand itemsets, users can choose the response format:
- A list of items by setting showItems=true
- A list of brands by setting showItems=false
Note: This API allows you to retrieve details only for successfully built item sets. Also, be aware that metadata may take 3-5 minutes (or longer for larger item sets) to become available.
URL: POST/api/v1/itemset/info
Request Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of the advertiser | integer | Y | Unique numeric identifier |
| Filter[itemsetId] | ID of the itemset for which details are to be retrieved. It accepts only single value for ID | integer | Y | Unique itemset |
| showItems | Applicable only for brand based itemsets . Note:
| |||
| startIndex | You can use this parameter to fetch specific number of items/brands from the available list. This indicates the starting position of the list | integer | N | Integer value Example: To return the first ten items/brands entries, set startIndex=0 and count=10 |
| count | Defines the total number of items/brands to be returned. You can use this parameter in combination with startIndex to fetch specific number of itemsets from a 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 items/brands 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/info' \ --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]": 13240239, "startIndex": 0, "count": 100, "showItems": true }' Response
| Element | Description | Type |
|---|---|---|
| code | Possible values of response code:
| string |
| itemsetId | ID of the item set | integer |
| totalResults | Total number of items or brands in the itemset | integer |
| items Note: this is returned:
| Elements of array:
| string |
| brands Note: _this is returned for brand based itemsets when showItems = false | Elements of array:
| string |
Sample Response for List Items in Item Based Itemset
{ "code": "success", "itemsetId": 13249, "totalResults": 4, "items": [ { "gtin" : "0007222015", "name": "AB SOURDOUGH ROUND 20OZ" }, { "gtin" : "0046326902", "name": "Architectural Record" }, { "gtin" : "006565147", "name": "Happy Bag" }, { "gtin" : "0978114526", "name": "Le ChoC" } ] } Sample Response for List Brands in Brand Based Itemset
{ "code": "success", "itemsetId": 13249, "totalResults": 2, "brands": [ { "name" : "great val1" }, { "name" : "eu1q" } ] } Sample Response: When showItems is true for a brand based item-set
{ "code": "success", "itemsetId": 13249, "totalResults": 2, "items": [ { "gtin" : "0007222015", "name": "AB SOURDOUGH ROUND 20OZ" }, { "gtin" : "0046326902", "name": "Architectural Record" } ]
} Updated 23 days ago