Home
POST/ad_campaign/{campaign_id}/delete_ads_by_inventory_reference
This method works with listings that are managed with the Inventory API.
The method deletes ads using a list of seller-defined inventory reference IDs, used with the Inventory API, that are associated with the specified campaign ID.
Specify the campaign ID (as a path parameter) and a list of inventoryReferenceId and inventoryReferenceType pairs to be deleted.
Call getCampaigns to get a list of the seller's current campaign IDs.
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 |
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
In addition, this method requires you to include the Content-Type header and its value should be set to "application/json". See HTTP request headers- opens rest request components page for details.
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/field | Type | Description |
---|---|---|
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. Occurrence: Required |
inventoryReferenceType | InventoryReferenceTypeEnum | Indicates the type of item the inventoryReferenceId references. The item can be either an You must always pair an inventoryReferenceId with and inventoryReferenceType. Occurrence: Required |
This call has no response headers.
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 |
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}. |
35061 | API_MARKETING | BUSINESS | The 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. |
35063 | API_MARKETING | BUSINESS | The campaign with 'campaign_id' {campaign_id} is ending soon. No update operations are allowed on this campaign until it ends. |
35064 | API_MARKETING | BUSINESS | This operation is only supported for key based campaigns. |
35072 | API_MARKETING | BUSINESS | InventoryReferenceId {inventoryReferenceId} is not eligible for Promoted Listings because it is a variation and variations can only be promoted using the parent ID to which it belongs. Replace this ID with the inventoryReferenceId of the parent and set 'inventoryReferenceType' to 'INVENTORY_ITEM_GROUP' |
35077 | API_MARKETING | BUSINESS | To use Promoted Listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity. |
35078 | API_MARKETING | BUSINESS | To gain access to Promoted Listings, you must be in good standing with recent sales activity. |
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.
This sample deletes the ad associated with the specified inventory reference ID from the specified campaign.
Pass the campaign_id of the add you want to delete as a URI parameter, and the inventory_reference_id and inventory_reference_type of the listing as payload fields.
POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/delete_ads_by_inventory_reference
This call returns the ID of the ad that was deleted.