HomeGuidesAPI Reference
Guides

List Itemset Campaign Association

Use this API to get a list of itemset campaign associations

📘

URL: POST/api/v1/itemsetAssociations/list

Request Parameters

ParameterNotesTypeRequiredPossible Values
advertiserId ID of the advertiserintegerYUnique numeric identifier
Filter[campaignIds]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[itemsetIds]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
Filter[lastModifiedDate]returns list of itemset campaign associations created/modified after the date specifieddateNDate should be in format:   yyyy-MM-dd'T'HH:mm:ss.SSSXXX
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[campaignIds] and Filter[itemsetIds] - details of all itemset campaign association for the advertiserId are returned
  • If you pass only Filter[campaignIds] - details of itemset campaign association for specified campaignIds are returned
  • If you pass only Filter[itemsetIds] - details of itemset campaign association for the specified itemsetIds are returned
  • If you pass both Filter[campaignIds] and Filter[itemsetIds]- 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

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[campaignIds]": [123,234,345],           "Filter[itemsetIds]": [567,678,789],            "Filter[lastModifiedDate]": "string",           "startIndex": 0,                                "count": 100                                }'

Response

ElementDescriptionType
totalResultsTotal number of rows returned in the responseinteger
responseresponse is an array holding the following elements:
  • campaignId: ID of the campaign, data type integer
  • itemsetId: ID of the itemset, data type integer
  • itemsetType: Type of itemset, data type string
    • Values: FEATURED
  • collection: Indicates whether the itemset contains a collection of Items or Brands, or if an existing itemset has been associated with the campaign. data type string
    • Values: ITEM, BRAND, ITEM_SET
  • creationDate: Date when the itemset was added to campaign. data type date
  • lastUpdatedDate: Date when itemset campaign association was last updated. data type date

Sample Response

{   "totalResults": 2,   "response": [   {             "campaignId": 123,             "itemsetId": 567,             "itemsetType": "FEATURED",             "collection": "ITEM",             "creationDate": "string",                    "lastUpdatedDate": "string",             },         {             "campaignId": 234,             "itemsetId": 789,             "itemsetType": "FEATURED",             "collection": "BRAND",             "creationDate": "string",                    "lastUpdatedDate": "string"         }     ] }

Updated 30 days ago