getAdsByInventoryReference | eBay Marketing API

GET/ad_campaign/{campaign_id}/get_ads_by_inventory_reference

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.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/get_ads_by_inventory_reference?

inventory_reference_type=string&

inventory_reference_id=string

URI parameters

Parameter	Type	Description
campaign_id	string	A 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
inventory_reference_type	string	The type of the inventory reference ID. Set this value to either `INVENTORY_ITEM` (a single listing) or `INVENTORY_ITEM_GROUP` (a multi-variation listing). You must always pass in both an inventory_reference_id and an inventory_reference_type. Occurrence: Required
inventory_reference_id	string	The inventory reference ID associated with the ad you want returned. A seller's inventory reference ID is the ID of either a listing or the ID of an inventory item group (the parent of a multi-variation listing, such as a shirt that is available in multiple sizes and colors). You must always supply in both an inventory_reference_id and an inventory_reference_type. Occurrence: Required

HTTP request headers

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

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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

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

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* Ads */

"ads" : [

{ /* Ad */

"adId" : "string",

"bidPercentage" : "string",

"inventoryReferenceId" : "string",

"inventoryReferenceType" : "InventoryReferenceTypeEnum : [INVENTORY_ITEM,INVENTORY_ITEM_GROUP]",

"listingId" : "string"

}

]

}

Response fields

Output container/field	Type	Description
ads	array of Ad	A list of ad IDs and the URIs that point to them. Occurrence: Conditional
ads.adId	string	A unique eBay-assigned ID for the ad that is generated when the ad is created. Occurrence: Always
ads.bidPercentage	string	The user-defined bid percentage (also known as the ad rate) sets level to which eBay should raise the visibility of the associated listing across the eBay buyer flows. The value is also used to calculate the Promoted Listings fee. Minimum value: 1.0 Maximum value: 100.0 Occurrence: Always
ads.inventoryReferenceId	string	An ID that identifies an 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 a inventory item group (a multiple-variation listing, such as a listing for shirt that's available in multiple sizes and colors). You must always specify both an inventoryRreferenceId and an inventoryReferenceType to indicate an item that's managed with the Inventory API. Occurrence: Conditional
ads.inventoryReferenceType	InventoryReferenceTypeEnum	Indicates the type of item the inventoryReferenceId references. The item can be either an `INVENTORY_ITEM` or `INVENTORY_ITEM_GROUP`. Occurrence: Conditional
ads.listingId	string	A unique eBay-assigned ID that is generated when a listing is created via the Trading API. Occurrence: Conditional

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.

Status	Meaning
200	Success
400	Bad Request
404	Not Found
409	Business error
500	Internal Server error

Error codes

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

Code	Domain	Category	Meaning
35001	API_MARKETING	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35002	API_MARKETING	APPLICATION	Internal error. Please wait a few minutes and try the call again.
35012	API_MARKETING	REQUEST	The inventory reference ID {inventoryReferenceId} is not valid.
35035	API_MARKETING	REQUEST	The campaign with 'campaign_id' {campaign_id} has ended.
35040	API_MARKETING	REQUEST	The inventory reference type is not valid. Valid values are: {inventoryRefereneTypeValues}.
35045	API_MARKETING	REQUEST	No campaign found for 'campaign_id' {campaign_id}.
35064	API_MARKETING	BUSINESS	This operation is only supported for key based campaigns.

Warnings

This call has no 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: 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.

Input

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

GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/get_ads_by_inventory_reference?inventory_reference_id=1********2&inventory_reference_type=INVENTORY_ITEM

Output

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