Add Itemsets to Campaigns
Use this API to add item sets to campaigns for performance tracking
URL: POST/api/v1/itemsetAssociation
Request Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of the advertiser | integer | Y | Unique numeric identifier |
| campaignId | ID of the campaign | integer | Y | Unique numeric identifier |
| itemsetId | ID of the itemset | integer | Y | Unique numeric identifier |
| itemsetType | Type of itemset | string | N | Values: featured |
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/itemsetAssociation' \ --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, "campaignId": 1, "itemsetId": 1234, "itemsetType": "featured" } ] ' Response
| Element | Description | Type |
|---|---|---|
| code | Possible values of response code:
| string |
| details | Details of the error if the value of response code is failure | string |
| campaignId | ID of the ad group | integer |
| itemsetId | ID of the item set | integer |
Sample Response
[ { "code": "success", "details": "CAMPAIGN_ITEMSET_ASSOCIATION_CREATED_SUCCESSFULLY", "campaignId": 1, "itemsetId": 1234 } ] Updated 30 days ago