List Itemset Campaign Association

This API helps users to fetch itemset associations of a campaign.

📘

URL: POST/api/v1/itemsetAssociations/list

Request Parameters

ParameterNotesTypeRequiredPossible Values
advertiserId ID of the advertiserintegerYUnique numeric identifier
Filter[campaignId]returns response for specific campaign IDs listed. If not specified, returns list of all itemsets associated with campaigns for an advertiser account

Note: Max size is 25
integerNUnique numeric identifier
Filter[itemsetId]returns response for specific itemset Ids listed. If not specified, returns list of all itemsets associated with campaigns for an in the advertiser account
Note: Max size is 25
integerNUnique numeric identifier
startIndexYou can use this parameter to fetch specific number of itemsets associations from a list. This indicates the starting position of the list

Note: To return the first ten itemsetAssociations, set startIndex=0 and count = 10
integerNValid integer value
countYou can use this parameter in combination with startIndex to fetch specific number of targets/audiences from the available list.

Note: To return the first ten itemsetAssociations, set startIndex=0 & defaultCount=100, maxCount=100, minCount=1
integerNValid integer value

Note:

  • If you dont pass both Filter[campaignId] and Filter[itemsetId] - details of all itemset campaign association for the advertiserId are returned
  • If you pass only Filter[campaignId] - details of itemset campaign association for specified campaignIds are returned
  • If you pass only Filter[itemsetId] - details of itemset campaign association for the specified itemsetIds are returned
  • If you pass both Filter[campaignId] and Filter[itemsetId]- details of itemset campaign associations for the matching combination of campaignIds and itemsetIds from the list specified, are returned

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 - List Itemset Campaign Association with brand, category, custom and no halo association

curl -X POST \ 'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/itemsetAssociations/list' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <auth_token>' \ --header 'WM_SEC.AUTH_SIGNATURE: ***********' \ --header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.intimestamp: 1565309779' \ --data '{      "advertiserId": 1,                               "Filter[campaignId]": [123,234,345],            "Filter[itemsetId]": [567,678,789],                "startIndex": 0,                                 "count": 100                                }' 

Response

ElementDescriptionType
totalResultsresult list countinteger
responseresponse is an array holding the following elements that are detailed in the below table.
The response objects are detailed

here


response Objects

ParametersNotesTypeRequiredPossible Values
itemsetIdID of the featured itemsetstringYUnique ID value
campaignIdID of the campaign that is associated with the itemsetstringYUnique campaign ID value
itemsetTypeType of itemset associated with campaign. Should always have value FEATUREDstringYFEATURED
haloItemsetIdID of the custom and halo itemsets
Note:
  • This field is applicable only if the campaign has an associated Halo itemset.
  • If haloAssociationType is set to BRAND, the list will contain exactly two itemset IDs.
list of integersN
haloAssociationTypeType of halo associationstringY
  • NONE: No halo itemset associated.
  • BRAND : Auto-generated halo itemset from the same brand(s) as the featured itemset, excluding excluding items already in the featured item set.
  • CATEGORY : Auto-generated halo itemset from the same brand and product categories as the featured itemset, excluding items already in the featured item set.
  • CUSTOM: User defined halo itemset
collectionTo indicate it’s an itemset.stringYITEM_SET

Sample Response - List Itemset Campaign Association with brand, category, custom and no halo association

{ "totalResults": 4, "response": [ { "campaignId": 123, "itemsetId": 567, "itemsetType": "FEATURED", "collection": "ITEM_SET", "haloItemsetId": [12,98] "haloAssociationType": "BRAND" }, { "campaignId": 234, "itemsetId": 678, "itemsetType": "FEATURED", "collection": "ITEM_SET", "haloItemsetId": [12], "haloAssociationType": "CATEGORY" }, { "campaignId": 345, "itemsetId": 789, "itemsetType": "FEATURED", "collection": "ITEM_SET", "haloItemsetId": [12], "haloAssociationType": "CUSTOM" }, { "campaignId": 344, "itemsetId": 7899, "itemsetType": "FEATURED", "collection": "ITEM_SET", "haloAssociationType": "NONE" } ]
}