Bid Multipliers

Bid Multiplier is a bidding feature that enables you with more options to optimize your campaigns. You can manage your sponsored products campaigns by promoting your products on prime placements and platforms using this feature. bid multiplier value ranges from 0 to 50000.

Note: Bid multipliers are optional and are available for both automatic (auto-bid) campaigns i.e., the campaigns with targeting type “auto” and keyword (manual) campaigns. Users will be able to update multipliers for following placements under each campaign type:

• Placements for Auto campaigns: Buy-Box, Search Ingrid, Stock Up, Home Page
• Placements for Manual campaigns: Buy-Box, Search Ingrid

There are two types of bid multipliers:

• Placement Multiplier: This control allows you to set bid starting at 0%. When your ads are eligible to serve in relevant placements, the bid multiplier percentages you set will help you compete better for these placements.

• Platform Multipliers: This control allows you to set bid multipliers starting at 0% for Desktop, App and Mobile platforms. When your ads serve on these platforms, the bid percentages you set will help you compete better for these platforms.

Note: Bid percentage will be restricted to first two decimal places for advertisers. Any decimal digit beyond the first 2 digits will be truncated without rounding off.

Description: Create placement bid multipliers for a campaign using this method.

URL: ​POST/api/v1/multipliers/placement

Query Parameters

Parameter	Notes	Type	Required	Possible Values
auth_token	The token will provide you the access to the API. It is same for all advertisers you access through the API.	string	Y	Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
campaignId	ID of the campaign	integer	Y	Unique numeric identifier
placementType	Type of the placement	string	Y	For auto campaigns: a) Buy-Box b) Search Ingrid  c) Home Page d) Stock Up For manual campaigns: a) Buy-Box b) Search Ingrid
multiplier	% Value by which original bid is modified	double	Y	Value of multiplier

Headers

Header Name	Description	Required	Values
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 further explanation on this
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_CONSUMER.intimestamp	Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp	Y	Use the signature generator code (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?auth_token=1234"  \
 -H "accept: application/json" \
-H "WM_SEC.AUTH_SIGNATURE: *************" \
-H "WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff" \
-H "WM_CONSUMER.intimestamp: 1565309779" \
-H "Content-Type: application/json"\ 
-d " [ 
        { 
          "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
  }
]

Description: Retrieve a list of all the placement bid multipliers for a campaign using this method.

URL: ​GET/api/v1/multipliers/placement

Query Parameters

Parameter	Notes	Type	Required	Possible Values
campaignId	ID of the campaign	integer	Y	Unique numeric identifier

Sample Request

curl-X GET \"https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/multipliers/placement?campaignId=1234&auth_token=1234"\
-H "accept: application/json"\
-H "WM_SEC.AUTH_SIGNATURE: ****************" \
-H "WM_CONSUMER.ID: adfwev23faasd2rafsasdfqeff" \
-H "WM_CONSUMER.intimestamp: 1565309779"\

Response

Element	Description	Type
campaignId	Id of the campaign	integer
placementType	Type of the placement. Values are: For auto campaigns: 1) Buy-Box 2) Search Ingrid  3) Home Page 4) Stock Up For manual campaigns: 1) Buy-Box 2) Search Ingrid	string
multiplier	% Value by which original bid is modified	double

Sample Response

[
  {
    "campaignId": 600000,
    "placementType": "Search Ingrid",
    "multiplier": 100
  }
]

Description: Update placement bid multipliers for a campaign using this method.

URL: ​PUT/api/v1/multipliers/placement

Query 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: 1) Buy-Box 2) Search Ingrid 3) Home Page 4) Stock Up For manual campaigns: 1) Buy-Box 2) Search Ingrid
multiplier	% Value by which original bid is modified	double	Y	Value of multiplier

Sample Request

curl -X PUT\
 "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/multipliers/placement?auth_token=1234" \
-H "accept: application/json"\
-H "WM_SEC.AUTH_SIGNATURE: *************"\
-H "WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff" \
-H "WM_CONSUMER.intimestamp: 1565309779" \
-H "Content-Type: application/json"\
-d " [ 
        {
           "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
  }
]

Description: Create platform bid multipliers for a campaign using this method.

URL: ​POST/api/v1/multipliers/platform

Query Parameters

Parameter	Notes	Type	Required	Possible Values
campaignId	ID of the campaign	integer	Y	Unique numeric identifier
platformType	Type of the platform	string	Y	Values are: Desktop, Mobile, App
multiplier	% Value by which original bid is modified	double	Y	Value of multiplier

Sample Request

curl -X POST\
 "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/multipliers/platform?auth_token=1234" \
-H "accept: application/json"\
-H "WM_SEC.AUTH_SIGNATURE: *************" \
-H "WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff" \
-H "WM_CONSUMER.intimestamp: 1565309779"\
-H "Content-Type: application/json" 
-d " [ 
      { 
        "campaignId": 600001,
        "platformType": "Desktop", 
        "multiplier": 300.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
platformMultiplierId	ID of the platform multiplier	integer

Sample Response

[
  {
    "code": "success",
    "details": "",
    "platformMultiplierId": 1001
  },
  {
    "code": "failure",
    "details": "The platform bid cannot be less than 0. Invalid platform type found”,
    "platformMultiplierId": 0
  }
]

Description: Retrieve a list of all the platform bid multipliers for a campaign using this method

URL: ​GET/api/v1/multipliers/platform

Query Parameters

Parameter	Notes	Type	Required	Possible Values
campaignId	ID of the campaign	integer	Y	Unique numeric identifier

Sample Request

curl -X GET \ "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/multipliers/platform?campaignId=1234&auth_token=1234" \
-H "accept: application/json"\
-H "WM_SEC.AUTH_SIGNATURE: ****************" \
-H "WM_CONSUMER.ID: adfwev23faasd2rafsasdfqeff" \
-H "WM_CONSUMER.intimestamp: 1565309779"\

Response

Element	Description	Type
campaignId	Id of the campaign	integer
platformType	Type of the platform. Values are: Desktop, Mobile, App	string
multiplier	% Value by which original bid is modified	double

Sample Response

[
  {
    "campaignId": 600000,
    "platformType": "Desktop",
    "multiplier": 100
  }
]

Description: Update platform bid multipliers for a campaign using this method.

URL: ​PUT/api/v1/multipliers/platform

Query Parameters

Parameter	Notes	Type	Required	Possible Values
campaignId	ID of the campaign	integer	Y	Unique numeric identifier
platformType	Type of the platform	string	Y	Values are: Desktop, Mobile, App
multiplier	% Value by which original bid is modified	double	Y	Value of multiplier

Sample Request

curl -X PUT\
"https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/multipliers/platform?auth_token=1234" \
-H "accept: application/json"\
-H "WM_SEC.AUTH_SIGNATURE: *************"\
-H "WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff" \
-H "WM_CONSUMER.intimestamp: 1565309779" \
-H "Content-Type: application/json"\
-d " [ 
        {
            "campaignId": 600001, 
           "platformType": "Desktop", 
           "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
platformMultiplierId	ID of the platform multiplier	integer

Sample Response

[
  {
    "code": "success",
    "details": "",
    "platformMultiplierId": 1001
  },
  {
    "code": "failure",
    "details": " The platform bid% cannot be less than 0 / Invalid platform type found",
    "platformMultiplierId": 0
  }
]