ebay.com – sell-marketing

OpenAPI apis-guru ecommerce

The Marketing API offers two platforms that sellers can use to promote and advertise their products:

Promoted Listings is an eBay ad service that lets sellers set up ad campaigns for the products they want to promote. eBay displays the ads in search results and in other marketing modules as SPONSORED listings. If an item in a Promoted Listings campaign sells, the seller is assessed a Promoted Listings fee, which is a seller-specified percentage applied to the sales price. For complete details, refer to the .
Promotions Manager gives sellers a way to offer discounts on specific items as a way to attract buyers to their inventory. Sellers can set up discounts (such as "20% off" and other types of offers) on specific items or on an entire customer order. To further attract buyers, eBay prominently displays promotion teasers throughout buyer flows. For complete details, see .

Marketing reports, on both the Promoted Listings and Promotions Manager platforms, give sellers information that shows the effectiveness of their marketing strategies. The data gives sellers the ability to review and fine tune their marketing efforts.

Important! Sellers must have an active eBay Store subscription, and they must accept the Terms and Conditions before they can make requests to these APIs in the Production environment. There are also site-specific listings requirements and restrictions associated with these marketing tools, as listed in the "requirements and restrictions" sections for and .

The table below lists all the Marketing API calls grouped by resource.

Homepage: https://api.apis.guru/v2/specs/ebay.com:sell-marketing/v1.14.0.json
Provider: ebay.com:sell-marketing / sell-marketing
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/ebay.com/sell-marketing/v1.14.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/ebay.com/sell-marketing/v1.14.0/openapi.yaml

Tools (71)

Extracted live via the executor SDK.

ad.bulkCreateAdsByInventoryReference
This method adds multiple listings that are managed with the to an existing Promoted Listings campaign.

For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) model, bulk ads may be directly created for the listing.

For each listing specified in the request, this method:
- Creates an ad for the listing.
- Sets the bid percentage (also known as the ad rate) for the ads created.
- Associates the ads created with the specified campaign.
To create ads for a listing, specify their inventoryReferenceId and inventoryReferenceType, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to which you want to associate the ads using the campaign_id path parameter.

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 in the Promoted Listings Playbook for more information.

Use to create a new campaign and use to get a list of existing campaigns.
ad.bulkCreateAdsByListingId
This method adds multiple listings to an existing Promoted Listings campaign using listingId values generated by the or , or using values generated by an ad group ID.
For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) funding model, bulk ads may be directly created for the listing.
For each listing ID specified in the request, this method:
- Creates an ad for the listing.
- Sets the bid percentage (also known as the ad rate) for the ad.
- Associates the ad with the specified campaign.
To create an ad for a listing, specify its listingId, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API.
You can specify a maximum of 500 listings per call and each campaign can have ads for a maximum of 50,000 items. Be aware when using this call that each variation in a multiple-variation listing creates an individual ad.
For Promoted Listings Advanced (PLA) campaigns using the Cost Per Click (CPC) funding model, an ad group must be created first. If no ad group has been created for the campaign, ads cannot be created.
For the ad group specified in the request, this method associates the ad with the specified ad group.
To create an ad for an ad group, specify the name of the ad group plus the defaultBid for the ad in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Ad groups are generated using the method.

You can specify one or more ad groups per campaign.
Use to create a new campaign and use to get a list of existing campaigns.
ad.bulkDeleteAdsByInventoryReference

This method works with listings created with the .

The method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified campaign. Inventory reference IDs are seller-defined IDs that are used with the Inventory API.

Pass the campaign_id as a path parameter and populate the payload with a list of inventoryReferenceId and inventoryReferenceType pairs that you want to delete.

Get the campaign IDs for a seller by calling and call to get a list of the seller's inventory reference 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 in the Promoted Listings Playbook for more information.
ad.bulkDeleteAdsByListingId

This method works with listing IDs created with either the or the .

The method deletes a set of ads, as specified by a list of listingID values from a Promoted Listings campaign. A listing ID value is generated by eBay when a seller creates a listing with either the Trading API and Inventory API.

Pass the campaign_id as a path parameter and populate the payload with the set of listing IDs that you want to delete.

Get the campaign IDs for a seller by calling and call to get a list of the seller's inventory reference 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 in the Promoted Listings Playbook for more information.

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

This method works with listings created with either the or the .
The method updates the bidPercentage values for a set of ads associated with the specified campaign.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their associated updated bidPercentage 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 and call to get a list of the seller's inventory reference 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 in the Promoted Listings Playbook for more information.
ad.bulkUpdateAdsBidByListingId

This method works with listings created with either the or the .
The method updates the bidPercentage values for a set of ads associated with the specified campaign.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their associated updated bidPercentage 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 and call to get a list of the seller's inventory reference 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 in the Promoted Listings Playbook for more information.
ad.bulkUpdateAdsStatus

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method works with listings created with either the or the .

This method updates the status of ads in bulk.

Specify the campaign_id you want to update as a URI parameter, and configure the adGroupStatus in the request payload.
ad.bulkUpdateAdsStatusByListingId

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method works with listings created with either the or the .

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 and call to retrieve a list of seller inventory reference IDs.
ad.createAdByListingId
This method adds a listing to an existing Promoted Listings campaign using a listingId value generated by the or , or using a value generated by an ad group ID.
For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing.
For the listing ID specified in the request, this method:
- Creates an ad for the listing.
- Sets the bid percentage (also known as the ad rate) for the ad.
- Associates the ad with the specified campaign.
To create an ad for a listing, specify its listingId, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ad with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API.
For Promoted Listings Advanced (PLA) campaigns using the Cost Per Click (CPC) funding model, an ad group must be created first. If no ad group has been created for the campaign, an ad cannot be created.
For the ad group specified in the request, this method associates the ad with the specified ad group.
To create an ad for an ad group, specify the name of the ad group in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Ad groups are generated using the method.

You can specify one or more ad groups per campaign.
Use to create a new campaign and use to get a list of existing campaigns.
This call has no response payload. If the ad is successfully created, a 201 Created HTTP status code and the URI of the ad are returned in the location header.
ad.createAdsByInventoryReference
This method adds a listing that is managed with the to an existing Promoted Listings campaign.

For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing.

For each listing specified in the request, this method:
- Creates an ad for the listing.
- Sets the bid percentage (also known as the ad rate) for the ads created.
- Associates the created ad with the specified campaign.
To create an ad for a listing, specify its inventoryReferenceId and inventoryReferenceType, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ad with using the campaign_id path parameter.

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 in the Promoted Listings Playbook for more information.

Use to create a new campaign and use to get a list of existing campaigns.
ad.deleteAd

This method removes the specified ad from the specified campaign.

Pass the ID of the ad to delete with the ID of the campaign associated with the ad as path parameters to the call.

Call to get the current list of the seller's 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 in the Promoted Listings Playbook for more information.

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

This method works with listings that are managed with the .
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 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 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.
ad.getAd

This method retrieves the specified ad from the specified campaign.
In the request, supply the campaign_id and ad_id as path parameters.

Call to retrieve a list of the seller's current campaign IDs and call to retrieve their current ad IDs.
ad.getAds

This method retrieves Promoted Listings ads that are associated with listings created with either the or the .
The method retrieves ads related to the specified campaign. Specify the Promoted Listings campaign to target with the campaign_id path parameter.

Because of the large number of possible results, you can use query parameters to paginate the result set by specifying a limit, which dictates how many ads to return on each page of the response. You can also specify how many ads to skip in the result set before returning the first result using the offset path parameter.

Call to retrieve the current campaign IDs for the seller.
ad.getAdsByInventoryReference

This method retrieves Promoted Listings ads associated with listings that are managed with the 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 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 in the Promoted Listings Playbook for more information.
ad.updateBid

This method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign.
In the request, supply the campaign_id and ad_id as path parameters, and supply the new bidPercentage value in the payload of the call.

Call to retrieve a seller's current campaign IDs and call to get their ad 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 in the Promoted Listings Playbook for more information.
adGroup.createAdGroup

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method adds an ad group to an existing PLA campaign that uses the Cost Per Click (CPC) funding model.

To create an ad group for a campaign, specify the defaultBid for the ad group in the payload of the request. Then specify the campaign to which the ad group should be associated using the campaign_id path parameter.

Each campaign can have one or more associated ad groups.
adGroup.getAdGroup

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method retrieves the details of a specified ad group, such as the ad group’s default bid and status.

In the request, specify the campaign_id and ad_group_id as path parameters.

Call to retrieve a list of the current campaign IDs for a seller and call for the ad group ID of the ad group you wish to retrieve.
adGroup.getAdGroups

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method retrieves ad groups for the specified campaigns.

Each campaign can only have one ad group.

In the request, supply the campaign_ids as path parameters.

Call to retrieve a list of the current campaign IDs for a seller.
adGroup.suggestBids

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method allows sellers to retrieve the suggested bids for input keywords and match type.
adGroup.suggestKeywords

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns.
adGroup.updateAdGroup

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method updates the ad group associated with a campaign.

With this method, you can modify the default bid for the ad group, change the state of the ad group, or change the name of the ad group. Pass the ad_group_id you want to update as a URI parameter, and configure the adGroupStatus and defaultBid in the request payload.

Call to retrieve the current default bid and status of the ad group that you would like to update.
adReport.getReport

This call downloads the report as specified by the report_id path parameter.

Call to schedule and generate a Promoted Listings report. All date values are returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ).

Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.
adReportMetadata.getReportMetadata

This call retrieves information that details the fields used in each of the Promoted Listings reports. Use the returned information to configure the different types of Promoted Listings reports.

The request for this method does not use a payload or any URI parameters.

Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.
adReportMetadata.getReportMetadataForReportType

This call retrieves metadata that details the fields used by a specific Promoted Listings report type. Use the report_type path parameter to indicate metadata to retrieve.

This method does not use a request payload.

Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.
adReportTask.createReportTask

Note: Using multiple funding models in one report is deprecated. If multiple funding models are used, a Warning will be returned in a header. This functionality will be decommissioned on April 3, 2023. See for details.

This method creates a report task, which generates a Promoted Listings report based on the values specified in the call.

The report is generated based on the criteria you specify, including the report type, the report's dimensions and metrics, the report's start and end dates, the listings to include in the report, and more. Metrics are the quantitative measurements in the report while dimensions specify the attributes of the data included in the reports.

When creating a report task, you can specify the items you want included in the report. The items you specify, using either listingId or inventoryReference values, must be in a Promoted Listings campaign for them to be included in the report.

For details on the required and optional fields for each report type, see .

This call returns the URL to the report task in the Location response header, and the URL includes the report-task ID.

Reports often take time to generate and it's common for this call to return an HTTP status of 202, which indicates the report is being generated. Call (or with the report-task ID) to determine the status of a Promoted Listings report. When a report is complete, eBay sets its status to SUCCESS and you can download it using the URL returned in the reportHref field of the getReportTask call. Report files are tab-separated value gzip files with a file extension of .tsv.gz.

Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.

Note: This call fails if you don't submit all the required fields for the specified report type. Fields not supported by the specified report type are ignored. Call to retrieve a list of the fields you need to configure for each Promoted Listings report type.
adReportTask.deleteReportTask

This call deletes the report task specified by the report_task_id path parameter. This method also deletes any reports generated by the report task.
Report task IDs are generated by eBay when you call . Get a complete list of a seller's report-task IDs by calling .
adReportTask.getReportTask

This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id path parameter.
The report task includes the report criteria (such as the report dimensions, metrics, and included listing) and the report-generation rules (such as starting and ending dates for the specified report task).

Report-task IDs are generated by eBay when you call . Get a complete list of a seller's report-task IDs by calling .
adReportTask.getReportTasks

This method returns information on all the existing report tasks related to a seller.
Use the report_task_statuses query parameter to control which reports to return. You can paginate the result set by specifying a limit, which dictates how many report tasks to return on each page of the response. Use the offset parameter to specify how many reports to skip in the result set before returning the first result.
campaign.cloneCampaign

This method clones (makes a copy of) the specified campaign's campaign criterion. The campaign criterion is a container for the fields that define the criteria for a rule-based campaign.
To clone a campaign, supply the campaign_id as a path parameter in your call. There is no request payload.

The ID of the newly-cloned campaign is returned in the Location response header.
Call to retrieve a seller's current campaign IDs.

Requirement: In order to clone a campaign, the campaignStatus must be ENDED and the campaign must define a set of selection rules (it must be a rules-based campaign).
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 in the Promoted Listings Playbook for more information.
campaign.createCampaign
This method creates a Promoted Listings ad campaign.
A Promoted Listings campaign is the structure into which you place the ads or ad group for the listings you want to promote.

Identify the items you want to place into a campaign either by "key" or by "rule" as follows:
- Rules-based campaigns – A rules-based campaign adds items to the campaign according to the criteria you specify in your call to createCampaign. You can set the autoSelectFutureInventory request field to true so that after your campaign launches, eBay will regularly assess your new, revised, or newly-eligible listings to determine whether any should be added or removed from your campaign according to the rules you set. If there are, eBay will add or remove them automatically on a daily basis.
- Key-based campaigns – Add items to an existing campaign using either listing ID values or Inventory Reference values:
  - Add listingId values to an existing campaign by calling either createAdByListingID or bulkCreateAdsByListingId.
  - Add inventoryReference values to an existing campaign by calling either createAdByInventoryReference or bulkCreateAdsByInventoryReference.
  - Add an ad group to an existing campaign by calling createAdGroup.
  Note: No matter how you add items to a Promoted Listings campaign, each campaign can contain ads for a maximum of 50,000 items.
  
  If a rules-based campaign identifies more than 50,000 items, ads are created for only the first 50,000 items identified by the specified criteria, and ads are not created for the remaining items.
  
  Creating a campaign
  
  To create a basic campaign, supply:
  - The user-defined campaign name
  - The start date (and optionally the end date) of the campaign
  - The eBay marketplace on which the campaign is hosted
  - Details on the campaign funding model
  The campaign funding model specifies how the Promoted Listings fee is calculated. Currently, the supported funding models are COST_PER_SALE and COST_PER_CLICK. For complete information on how the fee is calculated and when it applies, see .
  
  If you populate the campaignCriterion object in your createCampaign request, campaign "ads" are created by "rule" for the listings that meet the criteria you specify, and these ads are associated with the newly created campaign.
  
  For details on creating Promoted Listings campaigns and how to select the items to be included in your campaigns, see .
  
  For recommendations on which listings are prime for a Promoted Listings ad campaign and to get guidance on how to set the bidPercentage field, see .
  
  Tip: See for the details on the marketplaces that support Promoted Listings via the API. See for details about campaign limitations and restrictions.
campaign.deleteCampaign

This method deletes the campaign specified by the campaign_id query parameter.

Note: You can only delete campaigns that have ended.

Call to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.
campaign.endCampaign

This method ends an active (RUNNING) or paused campaign. Specify the campaign you want to end by supplying its campaign ID in a query parameter.
Call to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.
campaign.findCampaignByAdReference

This method retrieves the campaigns containing the listing that is specified using either a listing ID, or an inventory reference ID and inventory reference type pair. The request accepts either a listing_id, or an inventory_reference_id and inventory_reference_type pair, as used in the Inventory API.

eBay listing IDs are generated by either the or the when you create a listing.

An inventory reference ID can be either a seller-defined SKU or inventoryItemGroupKey, as specified in the Inventory API.

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 in the Promoted Listings Playbook for more information.
campaign.getCampaign

This method retrieves the details of a single campaign, as specified with the campaign_id query parameter.
This method returns all the details of a campaign (including the campaign's the selection rules), except the for the listing IDs or inventory reference IDs included in the campaign. These IDs are returned by .

Call to retrieve a list of the seller's campaign IDs.
campaign.getCampaignByName

This method retrieves the details of a single campaign, as specified with the campaign_name query parameter. Note that the campaign name you specify must be an exact, case-sensitive match of the name of the campaign you want to retrieve.
Call to retrieve a list of the seller's campaign names.
campaign.getCampaigns

This method retrieves the details for all of the seller's defined campaigns. Request parameters can be used to retrieve a specific campaign, such as the campaign's name, the start and end date, the status, and the funding model (Cost Per Sale (CPS) or Cost Per Click (CPC).
You can filter the result set by a campaign name, end date range, start date range, or campaign status. You can also paginate the records returned from the result set using the limit query parameter, and control which records to return using the offset parameter.
campaign.pauseCampaign

This method pauses an active (RUNNING) campaign.
You can restart the campaign by calling , as long as the campaign's end date is in the future.

Note: The listings associated with a paused campaign cannot be added into another campaign.

Call to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.
campaign.resumeCampaign

This method resumes a paused campaign, as long as its end date is in the future. Supply the campaign_id for the campaign you want to restart as a query parameter in the request.
Call to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.
campaign.suggestItems

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method allows sellers to obtain ideas for listings, which can be targeted for Promoted Listings campaigns.
campaign.updateAdRateStrategy

This method updates the ad rate strategy for an existing Promoted Listings Standard (PLS) rules-based ad campaign that uses the Cost Per Sale (CPS) funding model.

Specify the campaign_id as a path parameter. You can retrieve the campaign IDs for a seller by calling the method.

Note: This method only applies to the CPS funding model; it does not apply to the Cost Per Click (CPC) funding model. See in the Promoted Listings Playbook for more information.
campaign.updateCampaignBudget

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method updates the daily budget for a PLA campaign that uses the Cost Per Click (CPC) funding model.

A click occurs when an eBay user finds and clicks on the seller’s listing (within the search results) after using a keyword that the seller has created for the campaign. For each ad in an ad group in the campaign, each click triggers a cost, which gets subtracted from the campaign’s daily budget. If the cost of the clicks exceeds the daily budget, the Promoted Listings campaign will be paused until the next day.

Specify the campaign_id as a path parameter. You can retrieve the campaign IDs for a seller by calling the method.
campaign.updateCampaignIdentification

This method can be used to change the name of a campaign, as well as modify the start or end dates.
Specify the campaign_id you want to update as a URI parameter, and configure the campaignName and startDate in the request payload.
If you want to change only the end date of the campaign, specify the current campaign name and set startDate to the current date (you cannot use a start date that is in the past), and set the endDate as desired. Note that if you do not set a new end date in this call, any current endDate value will be set to null. To preserve the currently-set end date, you must specify the value again in your request.

Call to retrieve a seller's campaign details, including the campaign ID, campaign name, and the start and end dates of the campaign.
itemPriceMarkdown.createItemPriceMarkdownPromotion
This method creates an item price markdown promotion (know simply as a "markdown promotion") where a discount amount is applied directly to the items included the promotion. Discounts can be specified as either a monetary amount or a percentage off the standard sales price. eBay highlights promoted items by placing teasers for the items throughout the online sales flows.
Unlike an , a markdown promotion does not require the buyer meet a "threshold" before the offer takes effect. With markdown promotions, all the buyer needs to do is purchase the item to receive the promotion benefit.

Important: There are some restrictions for which listings are available for price markdown promotions. For details, see .

In addition, we recommend you list items at competitive prices before including them in your markdown promotions. For an extensive list of pricing recommendations, see the Growth tab in Seller Hub.

There are two ways to add items to markdown promotions:
- Key-based promotions select items using either the listing IDs or inventory reference IDs of the items you want to promote. Note that if you use inventory reference IDs, you must specify both the inventoryReferenceId and the associated inventoryReferenceType of the item(s) you want to include the promotion.
- Rule-based promotions select items using a list of eBay category IDs or seller Store category IDs. Rules can further constrain items in a promotion by minimum and maximum prices, brands, and item conditions.
New promotions must be created in either a DRAFT or a SCHEDULED state. Use the DRAFT state when you are initially creating a promotion and you want to be sure it's correctly configured before scheduling it to run. When you create a promotion, the promotion ID is returned in the Location response header. Use this ID to reference the promotion in subsequent requests (such as to schedule a promotion that's in a DRAFT state).

Tip: Refer to in the Selling Integration Guide for details and examples showing how to create and manage seller promotions.

Markdown promotions are available on all eBay marketplaces. For more information, see .
itemPriceMarkdown.deleteItemPriceMarkdownPromotion

This method deletes the item price markdown promotion specified by the promotion_id path parameter. Call to retrieve the IDs of a seller's promotions.

You can delete any promotion with the exception of those that are currently active (RUNNING). To end a running promotion, call and adjust the endDate field as appropriate.
itemPriceMarkdown.getItemPriceMarkdownPromotion

This method returns the complete details of the item price markdown promotion that's indicated by the promotion_id path parameter.

Call to retrieve the IDs of a seller's promotions.
itemPriceMarkdown.updateItemPriceMarkdownPromotion
This method updates the specified item price markdown promotion with the new configuration that you supply in the payload of the request. Specify the promotion you want to update using the promotion_id path parameter. Call to retrieve the IDs of a seller's promotions.

When updating a promotion, supply all the fields that you used to configure the original promotion (and not just the fields you are updating). eBay replaces the specified promotion with the values you supply in the update request and if you don't pass a field that currently has a value, the update request fails.

The parameters you are allowed to update with this request depend on the status of the promotion you're updating:
- DRAFT or SCHEDULED promotions: You can update any of the parameters in these promotions that have not yet started to run, including the discountRules.
- RUNNING promotions: You can change the endDate and the item's inventory but you cannot change the promotional discount or the promotion's start date.
- ENDED promotions: Nothing can be changed.
itemPromotion.createItemPromotion
This method creates an item promotion, where the buyer receives a discount when they meet the buying criteria that's set for the promotion. Known here as "threshold promotions", these promotions trigger when a threshold is met.
eBay highlights promoted items by placing teasers for the promoted items throughout the online buyer flows.

Discounts are specified as either a monetary amount or a percentage off the standard sales price of a listing, letting you offer deals such as "Buy 1 Get 1" and "Buy $50, get 20% off".

Volume pricing promotions increase the value of the discount as the buyer increases the quantity they purchase.

Coded Coupons provide unique codes that a buyer can use during checkout to receive a discount. The seller can specify the number of times a buyer can use the coupon and the maximum amount across all purchases that can be discounted using the coupon. The coupon code can also be made public (appearing on the seller's Offer page, search pages, the item listing, and the checkout page) or private (only on the seller's Offer page, but the seller can include the code in email and social media).

Note: Coded Coupons are currently available in the US, UK, DE, FR, IT, ES, and AU marketplaces.
There are two ways to add items to a threshold promotion:
- Key-based promotions select items using either the listing IDs or inventory reference IDs of the items you want to promote. Note that if you use inventory reference IDs, you must specify both the inventoryReferenceId and the associated inventoryReferenceType of the item(s) you want to include the promotion.
- Rule-based promotions select items using a list of eBay category IDs or seller Store category IDs. Rules can further constrain items in a promotion by minimum and maximum prices, brands, and item conditions.
You must create a new promotion in either a DRAFT or SCHEDULED state. Use the DRAFT state when you are initially creating a promotion and you want to be sure it's correctly configured before scheduling it to run. When you create a promotion, the promotion ID is returned in the Location response header. Use this ID to reference the promotion in subsequent requests.

Tip: Refer to the for details and examples showing how to create and manage threshold promotions using the Promotions Manager.

For information on the eBay marketplaces that support item promotions, see .
itemPromotion.deleteItemPromotion

This method deletes the threshold promotion specified by the promotion_id path parameter. Call to retrieve the IDs of a seller's promotions.

You can delete any promotion with the exception of those that are currently active (RUNNING). To end a running threshold promotion, call and adjust the endDate field as appropriate.
itemPromotion.getItemPromotion

This method returns the complete details of the threshold promotion specified by the promotion_id path parameter. Call to retrieve the IDs of a seller's promotions.
itemPromotion.updateItemPromotion
This method updates the specified threshold promotion with the new configuration that you supply in the request. Indicate the promotion you want to update using the promotion_id path parameter.
Call to retrieve the IDs of a seller's promotions.

When updating a promotion, supply all the fields that you used to configure the original promotion (and not just the fields you are updating). eBay replaces the specified promotion with the values you supply in the update request and if you don't pass a field that currently has a value, the update request will fail.

The parameters you are allowed to update with this request depend on the status of the promotion you're updating:
- DRAFT or SCHEDULED promotions: You can update any of the parameters in these promotions that have not yet started to run, including the discountRules.
- RUNNING or PAUSED promotions: You can change the endDate and the item's inventory but you cannot change the promotional discount or the promotion's start date.
- ENDED promotions: Nothing can be changed.
Tip: When updating a RUNNING or PAUSED promotion, set the status field to SCHEDULED for the update request. When the promotion is updated, the previous status (either RUNNING or PAUSED) is retained.
keyword.bulkCreateKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method adds keywords, in bulk, to an existing PLA ad group in a campaign that uses the Cost Per Click (CPC) funding model.

This method also sets the CPC rate for each keyword.

In the request, supply the campaign_id as a path parameter.

Call the method to retrieve a list of current campaign IDs for a specified seller.
keyword.bulkUpdateKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method updates the bids and statuses of keywords, in bulk, for an existing PLA campaign.

In the request, supply the campaign_id as a path parameter.

Call the method to retrieve a list of current campaign IDs for a specified seller.
keyword.createKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method creates keywords using a specified campaign ID for an existing PLA campaign.

In the request, supply the campaign_id as a path parameter.

Call the method to retrieve a list of keyword ideas to be targeted for PLA campaigns, and call the method to retrieve a list of current campaign IDs for a seller.
keyword.getKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method retrieves details on a specific keyword from an ad group within a PLA campaign that uses the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the method to retrieve a list of current campaign IDs for a seller and call the method to retrieve their keyword IDs.
keyword.getKeywords

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method can be used to retrieve all of the keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id as a path parameter. If one or more ad_group_ids are passed in the request body, the keywords for those ad groups will be returned. If ad_group_ids are not passed in the response body, the call will return all the keywords in the campaign.

Call the method to retrieve a list of current campaign IDs for a seller.
keyword.updateKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method updates keywords using a campaign ID and keyword ID for an existing PLA campaign.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the method to retrieve a list of current campaign IDs for a seller and call the method to retrieve their keyword IDs.
negativeKeyword.bulkCreateNegativeKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method adds negative keywords, in bulk, to an existing ad group in a PLA campaign that uses the Cost Per Click (CPC) funding model.

Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType.

Call the method to retrieve a list of current campaign IDs for a specified seller.
negativeKeyword.bulkUpdateNegativeKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method updates the statuses of existing negative keywords, in bulk.

Specify the negativeKeywordId and negativeKeywordStatus in the request body.
negativeKeyword.createNegativeKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method adds a negative keyword to an existing ad group in a PLA campaign that uses the Cost Per Click (CPC) funding model.

Specify the campaignId and adGroupId in the request body, along with the negativeKeywordText and negativeKeywordMatchType.

Call the method to retrieve a list of current campaign IDs for a specified seller.
negativeKeyword.getNegativeKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method retrieves details on a specific negative keyword.

In the request, specify the negative_keyword_id as a path parameter.
negativeKeyword.getNegativeKeywords

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method can be used to retrieve all of the negative keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.

The results can be filtered using the campaign_ids, ad_group_ids, and negative_keyword_status query parameters.

Call the method to retrieve a list of current campaign IDs for a seller.
negativeKeyword.updateNegativeKeyword

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 in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the method in Account API.
This method updates the status of an existing negative keyword.

Specify the negative_keyword_id as a path parameter, and specify the negativeKeywordStatus in the request body.
promotion.getListingSet
This method returns the set of listings associated with the promotion_id specified in the path parameter. Call to retrieve the IDs of a seller's promotions.
The listing details are returned in a paginated set and you can control and results returned using the following query parameters: limit, offset, q, sort, and status.
- Maximum associated listings returned: 200
- Default number of listings returned: 200
promotion.getPromotions

This method returns a list of a seller's undeleted promotions.
The call returns up to 200 currently-available promotions on the specified marketplace. While the response body does not include the promotion's discountRules or inventoryCriterion containers, it does include the promotionHref (which you can use to retrieve the complete details of the promotion).

Use query parameters to sort and filter the results by the number of promotions to return, the promotion state or type, and the eBay marketplace. You can also supply keywords to limit the response to the promotions that contain that keywords in the title of the promotion.

Maximum returned: 200
promotion.pausePromotion

This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from RUNNING to PAUSED. Pausing a promotion makes the promotion temporarily unavailable to buyers and any currently-incomplete transactions will not receive the promotional offer until the promotion is resumed. Also, promotion teasers are not displayed when a promotion is paused.

Pass the ID of the promotion you want to pause using the promotion_id path parameter. Call to retrieve the IDs of the seller's promotions.

Note: You can only pause threshold promotions (you cannot pause markdown promotions).
promotion.resumePromotion

This method restarts a threshold promotion that was previously paused and changes the state of the promotion from PAUSED to RUNNING. Only promotions that have been previously paused can be resumed. Resuming a promotion reinstates the promotional teasers and any transactions that were in motion before the promotion was paused will again be eligible for the promotion.

Pass the ID of the promotion you want to resume using the promotion_id path parameter. Call to retrieve the IDs of the seller's promotions.
promotionReport.getPromotionReports

This method generates a report that lists the seller's running, paused, and ended promotions for the specified eBay marketplace. The result set can be filtered by the promotion status and the number of results to return. You can also supply keywords to limit the report to promotions that contain the specified keywords.

Specify the eBay marketplace for which you want the report run using the marketplace_id query parameter. Supply additional query parameters to control the report as needed.
promotionSummaryReport.getPromotionSummaryReport

This method generates a report that summarizes the seller's promotions for the specified eBay marketplace. The report returns information on RUNNING, PAUSED, and ENDED promotions (deleted reports are not returned) and summarizes the seller's campaign performance for all promotions on a given site.

For information about summary reports, see .
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools