Skip to main content

POST/ad_campaign/{campaign_id}/bulk_update_ads_status_by_listing_id

Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method works with listings created with either the Trading API or the Inventory API.

The method updates the status of ads in bulk, based on listing ID values.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their updated adStatus values in the request body. An eBay listing ID is generated when a listing is created with the Trading API.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to retrieve a list of seller inventory reference IDs.

Input

Resource URI

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

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

ParameterTypeDescription
campaign_idstringThis path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being updated.

Use the getCampaigns method to retrieve campaign IDs.

Occurrence: Required

HTTP request headers

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

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
Content-TypestringThis header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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
requestsarray of UpdateAdStatusByListingIdRequest

An array of listing IDs and bid percentages.

Occurrence: Required

requests.adGroupIdstring

A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model.

Use the getAdGroups method to retrieve the ad group IDs for a seller.

Occurrence: Required

requests.adStatusAdStatusEnum

An enumeration value representing the current status of the ad.

Valid Values:

  • ACTIVE
  • PAUSED
  • ARCHIVED

Occurrence: Required

requests.listingIdstring

A unique eBay-assigned identifier for a listing that is generated when the listing is created.

Note: This field accepts both listing IDs (as generated by the Inventory API), and item IDs (as used in the eBay Traditional API set, such as the Trading and Finding APIs).

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
responsesarray of AdUpdateStatusByListingIdResponse

An array of processed ad listings in bulk.

Occurrence: Always

responses.adGroupIdstring

A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model.

Occurrence: Conditional

responses.errorsarray of ErrorDetailV3

A list of errors associated with the specified listing ID.

Occurrence: Conditional

responses.errors.categorystring

The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:

  • Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.
  • Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.
  • Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.

Occurrence: Conditional

responses.errors.domainstring

Name of the domain containing the service or application.

Occurrence: Conditional

responses.errors.errorIdinteger

A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

Occurrence: Conditional

responses.errors.inputRefIdsarray of string

Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.

Occurrence: Conditional

responses.errors.longMessagestring

An expanded version of message that should be around 100-200 characters long, but is not required to be such.

Occurrence: Conditional

responses.errors.messagestring

An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.

Occurrence: Conditional

responses.errors.outputRefIdsarray of string

Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.

Occurrence: Conditional

responses.errors.parametersarray of ErrorParameterV3

This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.

Occurrence: Conditional

responses.errors.parameters.namestring

Name of the entity that threw the error.

Occurrence: Conditional

responses.errors.parameters.valuestring

A description of the error.

Occurrence: Conditional

responses.errors.subdomainstring

Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.

Occurrence: Conditional

responses.hrefstring

The URI for the ad, which can be used to retrieve the ad.

Occurrence: Conditional

responses.listingIdstring

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

Occurrence: Conditional

responses.statusCodeinteger

An HTTP status code that indicates the response-status of the request.

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
207Multi Status
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.
35013API_MARKETINGREQUESTThe listing Id {listingId} is not valid.
35014API_MARKETINGREQUESTThe listing Id is required for this call.
35018API_MARKETINGREQUESTThere are duplicate listing Ids or inventoryReference Ids in this request. You must remove the duplicate.
35033API_MARKETINGREQUESTAt least one request is required for bulk requests.
35035API_MARKETINGREQUESTThe campaign with campaign id {campaign_id} has ended.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
35048API_MARKETINGREQUESTThe listing Id {listingId} is invalid or has ended.
35052API_MARKETINGBUSINESSThe category {categoryId} is not supported by the Promoted Listing service for multi-quantity listings.
35058API_MARKETINGBUSINESSThe listing Id {listingId} is not a fixed price item. This is a requirement for a promoted listing.
35059API_MARKETINGBUSINESSThe listing Id {listingId} is not a multi-quantity item. This is a requirement for a promoted listing.
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.
35071API_MARKETINGBUSINESSYou have exceeded the maximum number of listing Ids or inventory reference Ids. Only {maxSupportedNumber} Ids are supported per call.
35075API_MARKETINGBUSINESSThe category {categoryId} is not supported by the Promoted Listing service for single-quantity listings.
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.
35083API_MARKETINGREQUESTThe requested 'adStatus' is not valid.
35084API_MARKETINGBUSINESSThe Ad associated with listing Id {listingId} is archived.
35085API_MARKETINGBUSINESSThe 'adGroupId' {ad_group_id} does not exist under campaign {campaign_id}.
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.
36210API_MARKETINGREQUESTNo ad group found for ad group id {ad_group_id}.
36219API_MARKETINGREQUESTThe ad group with ad group id {ad_group_id} has been archived.

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: Update Ads Status by Listing ID

This example updates the status of ads in bulk, based on listing ID values.

Input

The inputs for this sample are the campaign_id of the ad campaign for which the ad(s) status shall be updated, as well as the listingId, adGroupId, and the updated adStatus in the request body.

POSThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/bulk_update_ads_status_by_listing_id

Output

If the call is successful, the details for the updated ad(s) are returned.