Update Editable Campaign Placements
Update (Include/ Exclude) an existing campaign placement using PUT operation.
URL: PUT/api/v1/placements
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| campaignId | The ID of the campaign. | integer | Y | A valid campaign ID |
| placements | This is an array holding following elements:
| array | Y | Placement: For Manual(keyword) campaign: Search Carousel, Item Buybox, Item Carousel Status: excluded, included |
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 PUT \'
https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/placements' \
--header 'Authorization: Bearer <auth_token >' \
--header 'accept: application/json' \
--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' \
--header 'Content-Type: application/json' \
--data '{ "campaignId": "600001", "placements": { "placement": "Search Carousel", "status": "excluded" } }'
Response
| Element | Description | Type |
|---|---|---|
| code | The response code can have values: success, failure | string |
| details | Details of the error if value of response code is failure | string |
| campaignId | ID of the campaign | integer |
Sample Response
[ { "code": "success", "details": "", "campaignId": 600001 } { "code": "failure", "details": "Campaign not found", "campaignId": 9999 }
]
Updated about 2 months ago