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.
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.
Servers
- https://api.ebay.com{basePath}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
campaign_id |
String | Yes |
A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
inventory_reference_type |
String | Yes |
The type of the inventory reference ID. Set this value to either |
inventory_reference_id |
String | Yes |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.