List All the Items in a Campaign
With help of GET operation, retrieve the list of all the products added to the campaign catalog.
URL: GET/api/v1/adItems
Query Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| campaignId | Id of the campaign where the ad group belongs | integer | Y | Unique numeric identifier |
Headers
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 GET\ 'https://developer.api.stg.walmart.com/api-
proxy/service/WPA/Api/v1/api/v1/adItems?campaignId=5601'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779'\
--header 'WM_SEC.KEY_VERSION: 1' \ --header 'accept: application/json'\
Response
| Element | Description | Type |
|---|---|---|
| campaignId | ID of the campaign | integer |
| adGroupId | ID of the ad group that is part of the campaign | integer |
| itemId | ID of the products that are being listed by this GET operation | string |
| adItemId | A product can be part of several Ad groups. adItemId is ID of the product that ties it to a specific ad group. | integer |
| bid | Cost per click set for the item | double |
| status | Specified status of ad item Status values: enabled, disabled | string |
| itemImageUrl | URL for image of Item | string |
| itemPageUrl | URL for item page | string |
| name | Name of the ad item | string |
| reviewStatus | Review outcome for the item. The values are: pending, approved, rejected | string |
| reviewReason | Description of why an item was rejected in review of Sponsored Brands ad group. more details can be found in overall review comments for the ad group if marked as “Other”. | string |
Sample Response
[ { "campaignId": 600001, "adGroupId": 600003, "itemId": 45769024, "adItemId": 600004, "bid": 0.6, "status": "enabled", "itemImageUrl": "https://i5.walmartimages.com/asr/905eb620-b036-48e9-b8df-8a00257efca0_1.cd6ce64707093979d61b67379b985e1d.jpeg?odnHeight=450&odnWidth=450&odnBg=ffffff", "itemPageUrl": "https://www.walmart.com/ip/45769024", "name": "TV Console", "reviewStatus": "pending", "reviewReason ": "text123" }
]
Updated about 2 months ago