Skip to main content

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.

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.

When using the CPC funding model, use the bulkUpdateAdsStatusByInventoryReference method to change the status of ads to ARCHIVED.

Input

Resource URI (production)

POST https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/delete_ads_by_inventory_reference

URI parameters

ParameterTypeDescription
campaign_idstringA unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.

Note: You can retrieve the campaign IDs for a specified seller using the getCampaigns method.

Occurrence: Required

HTTP request headers

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.

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

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription
inventoryReferenceIdstring

The inventory reference ID is a seller-defined SKU value for a single-item listing, or a seller-defined identifier for an inventory item group. Both of these values are defined when using the Inventory API, and an inventory item group is used to create a multiple-variation listing.

Occurrence: Required

inventoryReferenceTypeInventoryReferenceTypeEnum

The enumeration value passed into this field indicates the type of value used for the corresponding inventoryReferenceId value. The enumeration value used here will either be INVENTORY_ITEM (to delete the ad for a single SKU listing) or INVENTORY_ITEM_GROUP (to delete the ad for a multiple-variation listing).

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

{ /* AdIds */
"adIds" : []
}

Response fields

Output container/fieldTypeDescription
adIdsarray of string

A list of ad IDs. Only one ad can be deleted per operation and only one adId value will be returned.

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.

StatusMeaning
200Success
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.

CodeDomainCategoryMeaning
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}.
35061API_MARKETINGBUSINESSThe 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.
35063API_MARKETINGBUSINESSThe campaign with 'campaign_id' {campaign_id} is ending soon. No update operations are allowed on this campaign until it ends.
35064API_MARKETINGBUSINESSThis operation is only supported for key based campaigns.
35072API_MARKETINGBUSINESSInventoryReferenceId {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'
35077API_MARKETINGBUSINESSTo use Promoted Listings, you need to improve your seller level to Top Rated or Above Standard and have enough recent sales activity.
35078API_MARKETINGBUSINESSTo gain access to Promoted Listings, you must be in good standing with recent sales activity.
35089API_MARKETINGBUSINESSWe are currently testing a premium ads product with a small invite-only group. We will share more information when we are ready to expand.
36101API_MARKETINGREQUESTThis functionality is not supported for the CPC funding model.

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: Delete an Ad from a Campaign

This sample deletes the ad associated with the specified inventory reference ID from the specified campaign.

Input

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

Output

This call returns the ID of the ad that was deleted.