HomeGuidesAPI Reference
Guides

Itemsets Info

Use this API to retrieve the list of items or brands added to an itemset. It supports both Featured and Halo itemsets.

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

ParameterNotesTypeRequiredPossible Values
advertiserId ID of the advertiserintegerYUnique numeric identifier
Filter[itemsetId]ID of the itemset for which details are to be retrieved. It accepts only single value for IDintegerYUnique itemset
showItemsApplicable only for brand based itemsets .
Note:
  • Default value = false
  • For brand based itemset:
    • When showItems = false, API returns metadata as a list of brands used to create the itemset
    • when showItems = true, API returns metadata as a list of items, used to create the itemset (up to 10,000 items)
  • For item, category, and hybrid itemsets, this parameter is always true, and the API returns a list of items used to create the itemset (up to 10,000 items)
startIndexThe index of the first record to return (used for pagination). Default: 0integerNInteger value

Example: To return the first ten items/brands entries, set startIndex=0 and count=10
countNumber of records to return.
Default: 100. Max: 100		integerNNumber 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 NameDescriptionRequiredValues
AuthorizationThe token will provide you the access to the API. It is same for all advertisers you access through the API.YPlease utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.IDWe will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.   YPlease 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_SIGNATUREAuth signature as an API key.YUse the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSIONWe will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.Y1
WM_CONSUMER.intimestampTimestamp for which the auth signature is generated. Use Unix epoch format for the timestamp.YUse 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

ElementDescriptionType
codePossible values of response code:
  • success
  • failure
string
itemsetIdID of the item setinteger
totalResultsTotal number of items or brands in the itemsetinteger
items
Note: this is returned:
  • for item, category and hybrid itemsets
  • _when showItems = true for brand based itemset
Elements of array:
  • gtin: GTIN of the item
    • Data type string
  • name: Name of the item
    • Data type string
array of objects
brands
Note: _this is returned for brand based itemsets when showItems = false		Elements of array:
  • name: Name of the brand
    • Data type string
array of strings

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: List Items/Brands in Itemset - Brand Based when showItems is false

{     "code": "success",     "itemsetId": 13249,     "totalResults": 2,     "brands": [           {              "name" : "great val1"           },          {             "name" : "eu1q"          }    ] }

Sample Response: List Items/Brands in Itemset - Brand Based when showItems is true

{ "code": "success", "itemsetId": 13249, "totalResults": 2, "items": [ { "gtin" : "0007222015", "name": "AB SOURDOUGH ROUND 20OZ" }, { "gtin" : "0046326902", "name": "Architectural Record" } ]
}

Updated 2 days ago