Skip to main content


This method retrieves Promoted Listings ads associated with listings that are managed with the Inventory API from the specified campaign.

Supply the campaign_id as a path parameter and use query parameters to specify the inventory_reference_id and inventory_reference_type pairs.

In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for an inventory item group, which is an entity that's used in the Inventory API to create a multiple-variation listing). To indicate a listing managed by the Inventory API, you must always specify both an inventory_reference_id and the associated inventory_reference_type.

Call getCampaigns to retrieve all of the seller's the current campaign IDs.

Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.


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 ads being retrieved.

Use the getCampaigns method to retrieve campaign IDs.

Occurrence: Required

inventory_reference_typestringThis query parameter specifies the type of the item the inventory_reference_id references.

See InventoryReferenceType for supported values.

Occurrence: Required

inventory_reference_idstringThis query parameter specifies the unique identifier of a single-item listing or a multi-variation listing.

To retrieve an ad for a single-item listing, set the inventoryReferenceType value to INVENTORY_ITEM and specify an item ID or a SKU (if the SKU is defined in the listing).

To retrieve an ad for a multi-variation listing, set the inventoryReferenceType value to INVENTORY_ITEM_GROUP and specify the item ID for the multi-variation listing or the inventoryitemGroupKey value as defined in the Inventory API.

Occurrence: Required

HTTP request headers

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

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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

This call has no payload.

Request fields

This call has no field definitions.


HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
adsarray of Ad

A list of ad IDs. An ad ID is generated for each successfully created ad.

Occurrence: Always


A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. This ID is created after a successful createAdGroup call, and all ad groups must be associated with a CPC campaign.

Occurrence: Conditional


A unique eBay-assigned ID that is generated when the ad is created.

Occurrence: Always


The current status of the CPC ad.

Valid Values:

Note: This type only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model.

Occurrence: Conditional

ads.alertsarray of Alert

An array containing alert messages for the ad.

Occurrence: Conditional


The type of alert message. For example, an invalid bid percentage.

Occurrence: Conditional

ads.alerts.detailsarray of AlertDetails

A description of the alert including dimensions and aspects.

Occurrence: Conditional


The dimension information of the alert including keys and values.

Occurrence: Conditional


The key field of the applied dimension. For example, the marketplace Id.

Occurrence: Conditional


The value field of the applied dimension. For example, if the key is a MARKETPLACE_ID, the value would be from MarketplaceIdEnum.

Occurrence: Conditional


The aspect information of the alert including keys and values.

Occurrence: Conditional


The type of the aspect. For example, MINIMUM_REQUIRED.

Occurrence: Conditional


The value of the aspect. For example, if the aspect is a percentage, a value of '2.0' would equal 2%.

Occurrence: Conditional


The 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.

The bidPercentage is a single precision value that is guided by the following rules:

  • These values are valid:
       4.1,    5.0,    5.5, ...
  • These values are not valid:
       0.01,    10.75,    99.99,
       and so on.
This is default bid percentage for the campaigns using the Cost Per Sale (CPS) funding model, and this value will be overridden by any ads in the campaign that have their own set bid percentages.

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

Note:This field will always be returned for campaigns that use the Cost Per Sale (CPS) funding model. It will not be returned for campaigns that use the Cost Per Click (CPC) funding model.

Note: This field has a minimum value of 2.0 and a maximum value of 100.0.

Occurrence: Conditional


An ID that identifies a single-item listing or multiple-variation listing that is managed with the Inventory API.

The inventory reference ID is a seller-defined value that can be either an SKU for a single-item listing or an inventoryItemGroupKey for a multiple-value listing.

An inventoryItemGroupKey is a value that the seller defines to indicate a listing that's the parent of an inventory item group (a multiple-variation listing, such as a listing for a shirt that's available in multiple sizes and colors).

This field is only returned if the ad is associated with a SKU or an inventory item group value.

Occurrence: Always


The enumeration value returned here indicates the type of listing the inventoryReferenceId references. The value returned here will be INVENTORY_ITEM for a single-variation listing, or INVENTORY_ITEM_GROUP for a multiple-variation listing.

This field is only returned if the ad is associated with a SKU or an inventory item group value.

Occurrence: Always


A unique eBay-assigned ID that is generated when a listing is created.

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.
35002API_MARKETINGAPPLICATIONInternal error. Please wait a few minutes and try the call again.
35012API_MARKETINGREQUESTThe inventory reference ID {inventoryReferenceId} is not valid.
35035API_MARKETINGREQUESTThe campaign with campaign id {campaign_id} has ended.
35040API_MARKETINGREQUESTThe inventory reference type is not valid. Valid values are: {inventoryReferenceTypeValues}.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
35064API_MARKETINGBUSINESSThis operation is only supported for key based campaigns.
35077API_MARKETINGBUSINESSTo use promoted listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity.
36106API_MARKETINGREQUESTThe 'adGroupId' is not supported for CPS funding model.


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 an Ad by Inventory Reference Id

This sample retrieves the ad for the listing specified from the campaign with the ID of 1********4.


The inputs for this sample are campaign_id as a URI parameter and the inventory_reference_id and inventory_reference_type of the listing.



The output is the adId and the details of the ad.

Got thoughts? Click the feedback button – your insights help us improve!