Skip to main content


Note: This method is only available for select partners who have been approved for the eBay priority strategy program. For information about how to request access to this program, refer to Priority Strategy Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for priority strategy, use the getAdvertisingEligibility method in Account API.
This method allows sellers to retrieve the suggested bids for input keywords and match type.


Resource URI


This method is supported in Sandbox environment. To access the endpoint, just replace the root URI with

URI parameters

campaign_idstringThis path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the keywords for which bid suggestions will be provided.

Use the getCampaigns method to retrieve campaign IDs.

Occurrence: Required

ad_group_idstringThis path parameter specifies the unique identifier of the ad group containing the keywords for which the bid suggestions will be provided.

Use the getAdGroups method to retrieve ad group IDs.

Occurrence: Required

HTTP request headers

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

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Content-TypestringThis header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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):

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription
keywordsarray of KeywordRequest

An array of keywords for which bids will be required.

Maximum number of keywords: 500

Occurrence: Required


The text of the keyword. Keywords are not case sensitive and compound words can be used without additional encoding (for example, tennis ball).

You can use the getKeywords method to retrieve keyword values currently associated with the specified ad group.

Maximum number of characters: 100

Maximum number of words: 10

Occurrence: Required


A field that defines the match type for the keyword.

Valid Values:


Occurrence: Required


HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
suggestedBidsarray of SuggestedBids

A list of bids in the paginated collection.

Occurrence: Conditional


The text for the keyword.

Occurrence: Always


A field that defines the match type for the keyword.

Valid Values:


Occurrence: Always


The suggested bid associated with the keyword.

Occurrence: Conditional


The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Always


The end of the range specified for the bid.

Occurrence: Always


The start of the range specified for the bid.

Occurrence: Always


The value of the proposed bid.

Occurrence: Always

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.

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.

35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35041API_MARKETINGREQUESTThe 'marketplaceId' is required.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
35051API_MARKETINGBUSINESS'marketplaceId' {marketplaceId} is not supported. Promoted Listings is supported only on these marketplaces: {supportedMarketplaces}.
35091API_MARKETINGREQUESTYou have exceeded the maximum number of requests. Only {maxSupportedNumber} are supported per call.
36210API_MARKETINGREQUESTNo ad group found for ad group id {ad_group_id}.
36301API_MARKETINGREQUESTThe provided keyword match type is not supported. Valid values are: {matchTypeValues}.
36304API_MARKETINGREQUESTThe keywordText {keywordText} cannot be more than {maxKeywordTextLength} characters.
36311API_MARKETINGREQUESTThe keywordText cannot be null or empty.
36312API_MARKETINGREQUESTThe keywordText contains invalid characters {invalidCharacters}
36320API_MARKETINGBUSINESSThe keywordText {keywordText} cannot have total number of words more than {maxWordsInKeyword} words


This call has no warnings.


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: Retrieve Bid Suggestions

This example retrieves the suggested bids for a specified set of keywords and match types.


The inputs for this sample are the campaign_id and ad_group_id path parameters, as well as the keywordText and matchType of the keywords for which the suggested bids shall be retrieved.



If the call is successful, suggested bids for the specified keywords are returned.