Description

Create placement bid multipliers for a campaign using this method.

URL: POST/api/v1/multipliers/placement

Request Parameters

Parameter	Notes	Type	Required	Possible Values
campaignId	ID of the campaign	integer	Y	Unique numeric identifier
placementType	Type of the placement	string	Y	For auto campaigns: Buy-Box Search Ingrid Home Page Stock Up For manual campaigns: Buy-Box Search Ingrid
multiplier	% Value by which original bid is modified	double	N	Value of multiplier Note: For TROAS campaigns, we do not support placement bid multipliers. If multiplier is passed, this will be ignored by the system.

Parameter

Notes

Type

Required

Possible Values

campaignId

ID of the campaign

integer

Unique numeric identifier

placementType

Type of the placement

string

For auto campaigns:

Buy-Box
Search Ingrid
Home Page
Stock Up

For manual campaigns:

Buy-Box
Search Ingrid

multiplier

% Value by which original bid is modified

double

Value of multiplier
Note: For TROAS campaigns, we do not support placement bid multipliers. If multiplier is passed, this will be ignored by the system.

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.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/multipliers/placement' \
--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' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '{ "campaignId": 600001, "placementType": "Buy-Box", "multiplier": 100.0 }'

Response

Element	Description	Type
code	The response code can have following values: `success`, `failure`	string
details	Details of the error if value of response code is `failure`	string
placementMultiplierId	ID of the placement multiplier	integer

Sample Response

[ { "code": "success", "details": "", "placementMultiplierId": 1001 }, { "code": "failure", "details": "The placement bid% cannot be less than 0 / Invalid Placement Type found", "placementMultiplierId": 0 }
]