marketing APIv1.10.0

updateBid

POST
/ad_campaign/{campaign_id}/ad/{ad_id}/update_bid
This method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign.

In the request, supply the campaign_id and ad_id as path parameters, and supply the new bidPercentage value in the payload of the call.

Call getCampaigns to retrieve a seller's current campaign IDs and call getAds to get their ad IDs.

Input

Resource URI (production)

POST https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/ad/{ad_id}/update_bid

URI parameters

ParameterTypeDescription
campaign_idstringA unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling getCampaigns.

Occurrence: Required

ad_idstringA unique eBay-assigned ID for an ad that's generated when an ad is created.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.marketing

See OAuth access tokens for more information.

Input container/fieldTypeDescription
bidPercentagestringThe user-defined bid percentage (also known as the ad rate) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing.

The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee.

The Promoted Listings fee is determined at the time the transaction completes and the seller is assessed the fee only when an item sells through a Promoted Listings ad campaign.

bidPercentage is a single precision value that is guided by the following rules:
  • These values are valid:
       1,    1.0,    4.1,
       5.0,    5.5, ...
  • These values are not valid:
       0.01,    10.75,    99.99,
       and so on.

If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign.

Minimum value: 1.0
Maximum value: 100.0

Occurrence: Required

Output

HTTP response headers

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
204No content
400Bad Request
404Not Found
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35002API_MARKETINGAPPLICATIONInternal error. Please wait a few minutes and try the call again.
35007API_MARKETINGREQUESTThe 'bidPercentage' {bidPercentage} is not valid. The bid percentage should be a single precision value. Minimum value: {minBidPercent} , Maximum value:{maxBidPercent}. Example of valid values: 4.1, 4.10, 5.5, 5.0, etc. Invalid values: 4.44, 8.11, etc.
35035API_MARKETINGREQUESTThe campaign with 'campaign_id' {campaign_id} has ended.
35044API_MARKETINGREQUESTNo Ad found for 'ad_id' {ad_id}. Please correct the 'ad_id' and try again.
35045API_MARKETINGREQUESTNo campaign found for 'campaign_id' {campaign_id}.
35048API_MARKETINGREQUESTThe listing ID {listingId} is invalid or has ended.
35052API_MARKETINGBUSINESSThe category {categoryId} is not supported by the Promoted Listing service for multi-quantity listings.
35058API_MARKETINGBUSINESSThe listing ID {listingId} is not a fixed price item. This is a requirement for a promoted listing.
35059API_MARKETINGBUSINESSThe listing ID {listingId} is not a multi-quantity item. This is a requirement for a promoted listing.
35061API_MARKETINGBUSINESSThe campaign with 'campaign_id' {campaign_id} is being synced to match the specifications of the campaign. Please wait a few minutes and try the call again.
35063API_MARKETINGBUSINESSThe campaign with 'campaign_id' {campaign_id} is ending soon. No update operations are allowed on this campaign until it ends.
35064API_MARKETINGBUSINESSThis operation is only supported for key based campaigns.
35075API_MARKETINGBUSINESSThe category {categoryId} is not supported by the Promoted Listing service for single-quantity listings.
35077API_MARKETINGBUSINESSTo use Promoted Listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity.
35078API_MARKETINGBUSINESSTo gain access to Promoted Listings, you must be in good standing with recent sales activity.

Warnings

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Update the Bid Percentage

This sample updates the bid percentage for the specified ad to 11 percent.

Input

The inputs for this sample are bidPercentage and the campaign_id and ad_idas URI parameters.
POST
https://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/ad/1********4/update_bid

Output

A successful call returns the HTTP status code 204 No content. This method has no response payload.