eBay

Marketing API

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…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 Promoted Listings playbook . 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 Promotions Manager . 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 Promoted Listings and Promotions Manager . The table below lists all the Marketing API calls grouped by resource.

Endpoints 69

campaign

  • GETgetCampaigns/ad_campaign?campaign_name=string&campaign_status=string&end_date_range=string&funding_strategy=string&limit=string&offset=string&start_date_range=stringThis 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…
  • POSTcreateCampaign/ad_campaignThis method creates a Promoted Listings ad campaign. <p>A Promoted Listings <i>campaign</i> is the structure into which you place the ads or ad group for the…
  • GETfindCampaignByAdReference/ad_campaign/find_campaign_by_ad_reference?inventory_reference_id=string&inventory_reference_type=string&listing_id=stringThis method retrieves the campaigns containing the listing that is specified using either a listing ID, or an inventory reference ID and inventory reference…
  • GETgetCampaignByName/ad_campaign/get_campaign_by_name?campaign_name=stringThis method retrieves the details of a single campaign, as specified with the <b>campaign_name</b> query parameter. Note that the campaign name you specify…
  • GETgetCampaign/ad_campaign/:campaign_idThis method retrieves the details of a single campaign, as specified with the <b>campaign_id</b> query parameter. <p>This method returns all the details of a…
  • DELETEdeleteCampaign/ad_campaign/:campaign_idThis method deletes the campaign specified by the <code>campaign_id</code> query parameter.<br /><br /><span class="tablenote"><b>Note: </b> You can only…
  • POSTcloneCampaign/ad_campaign/:campaign_id/cloneThis method clones (makes a copy of) the specified campaign's <b>campaign criterion</b>. The <b>campaign criterion</b> is a container for the fields that…
  • POSTendCampaign/ad_campaign/:campaign_id/endThis method ends an active (<code>RUNNING</code>) or paused campaign. Specify the campaign you want to end by supplying its campaign ID in a query parameter.…
  • POSTpauseCampaign/ad_campaign/:campaign_id/pauseThis method pauses an active (RUNNING) campaign. <p>You can restart the campaign by calling <a…
  • POSTresumeCampaign/ad_campaign/:campaign_id/resumeThis method resumes a paused campaign, as long as its end date is in the future. Supply the <b>campaign_id</b> for the campaign you want to restart as a query…
  • GETsuggestItems/ad_campaign/:campaign_id/suggest_items?category_ids=string&limit=string&offset=string<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTupdateAdRateStrategy/ad_campaign/:campaign_id/update_ad_rate_strategyThis 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…
  • POSTupdateCampaignBudget/ad_campaign/:campaign_id/update_campaign_budget<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTupdateCampaignIdentification/ad_campaign/:campaign_id/update_campaign_identificationThis method can be used to change the name of a campaign, as well as modify the start or end dates. <p>Specify the <b>campaign_id</b> you want to update as a…

ad

  • GETgetAds/ad_campaign/:campaign_id/ad?ad_group_ids=string&ad_status=string&limit=string&listing_ids=string&offset=stringThis method retrieves Promoted Listings ads that are associated with listings created with either the <a href="/Devzone/XML/docs/Reference/eBay/index.html"…
  • POSTcreateAdByListingId/ad_campaign/:campaign_id/adThis method adds a listing to an existing Promoted Listings campaign using a <b>listingId</b> value generated by the <a…
  • GETgetAd/ad_campaign/:campaign_id/ad/:ad_idThis method retrieves the specified ad from the specified campaign. <p>In the request, supply the <b>campaign_id</b> and <b>ad_id</b> as path parameters.</p>…
  • DELETEdeleteAd/ad_campaign/:campaign_id/ad/:ad_idThis method removes the specified ad from the specified campaign.<br /><br />Pass the ID of the ad to delete with the ID of the campaign associated with the…
  • POSTupdateBid/ad_campaign/:campaign_id/ad/:ad_id/update_bidThis method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign. <p>In the request, supply the…
  • POSTbulkCreateAdsByInventoryReference/ad_campaign/:campaign_id/bulk_create_ads_by_inventory_referenceThis method adds multiple listings that are managed with the <a href="/api-docs/sell/inventory/resources/methods" title="Inventory API Reference">Inventory…
  • POSTbulkCreateAdsByListingId/ad_campaign/:campaign_id/bulk_create_ads_by_listing_idThis method adds multiple listings to an existing Promoted Listings campaign using <b>listingId</b> values generated by the <a…
  • POSTbulkDeleteAdsByInventoryReference/ad_campaign/:campaign_id/bulk_delete_ads_by_inventory_referenceThis method works with listings created with the <a href="/api-docs/sell/inventory/resources/methods" title="Inventory API Reference">Inventory API</a>.<br…
  • POSTbulkDeleteAdsByListingId/ad_campaign/:campaign_id/bulk_delete_ads_by_listing_idThis method works with listing IDs created with either the <a href="/Devzone/XML/docs/Reference/eBay/index.html" title="Trading API Reference">Trading API</a>…
  • POSTbulkUpdateAdsBidByInventoryReference/ad_campaign/:campaign_id/bulk_update_ads_bid_by_inventory_referenceThis method works with listings created with either the <a href="/Devzone/XML/docs/Reference/eBay/index.html" title="Trading API Reference">Trading API</a> or…
  • POSTbulkUpdateAdsBidByListingId/ad_campaign/:campaign_id/bulk_update_ads_bid_by_listing_idThis method works with listings created with either the <a href="/Devzone/XML/docs/Reference/eBay/index.html" title="Trading API Reference">Trading API</a> or…
  • POSTbulkUpdateAdsStatus/ad_campaign/:campaign_id/bulk_update_ads_status<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTbulkUpdateAdsStatusByListingId/ad_campaign/:campaign_id/bulk_update_ads_status_by_listing_id<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTcreateAdsByInventoryReference/ad_campaign/:campaign_id/create_ads_by_inventory_referenceThis method adds a listing that is managed with the <a href="/api-docs/sell/inventory/resources/methods" title="Inventory API Reference">Inventory API</a> to…
  • POSTdeleteAdsByInventoryReference/ad_campaign/:campaign_id/delete_ads_by_inventory_referenceThis method works with listings that are managed with the <a href="/api-docs/sell/inventory/resources/methods" title="Inventory API Reference">Inventory…
  • GETgetAdsByInventoryReference/ad_campaign/:campaign_id/get_ads_by_inventory_reference?inventory_reference_id=string&inventory_reference_type=stringThis method retrieves Promoted Listings ads associated with listings that are managed with the <a href="/api-docs/sell/inventory/resources/methods"…

ad_group

  • GETgetAdGroups/ad_campaign/:campaign_id/ad_group?ad_group_status=string&limit=string&offset=string<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTcreateAdGroup/ad_campaign/:campaign_id/ad_group<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • GETgetAdGroup/ad_campaign/:campaign_id/ad_group/:ad_group_id<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • PUTupdateAdGroup/ad_campaign/:campaign_id/ad_group/:ad_group_id<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTsuggestBids/ad_campaign/:campaign_id/ad_group/:ad_group_id/suggest_bids<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTsuggestKeywords/ad_campaign/:campaign_id/ad_group/:ad_group_id/suggest_keywords<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…

keyword

  • POSTbulkCreateKeyword/ad_campaign/:campaign_id/bulk_create_keyword<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTbulkUpdateKeyword/ad_campaign/:campaign_id/bulk_update_keyword<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • GETgetKeywords/ad_campaign/:campaign_id/keyword?ad_group_ids=string&keyword_status=string&limit=string&offset=string<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTcreateKeyword/ad_campaign/:campaign_id/keyword<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • GETgetKeyword/ad_campaign/:campaign_id/keyword/:keyword_id<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • PUTupdateKeyword/ad_campaign/:campaign_id/keyword/:keyword_id<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…

ad_report

  • GETgetReport/ad_report/:report_idThis call downloads the report as specified by the <b>report_id</b> path parameter. <br><br>Call <a…

ad_report_metadata

  • GETgetReportMetadata/ad_report_metadataThis call retrieves information that details the fields used in each of the Promoted Listings reports. Use the returned information to configure the different…
  • GETgetReportMetadataForReportType/ad_report_metadata/:report_typeThis call retrieves metadata that details the fields used by a specific Promoted Listings report type. Use the <b>report_type</b> path parameter to indicate…

ad_report_task

  • GETgetReportTasks/ad_report_task?limit=string&offset=string&report_task_statuses=stringThis method returns information on all the existing report tasks related to a seller. <p>Use the <b>report_task_statuses</b> query parameter to control which…
  • POSTcreateReportTask/ad_report_task<span class="tablenote"><b>Note:</b> Using multiple funding models in one report is deprecated. If multiple funding models are used, a Warning will be…
  • GETgetReportTask/ad_report_task/:report_task_idThis call returns the details of a specific Promoted Listings report task, as specified by the <b>report_task_id</b> path parameter. <p>The report task…
  • DELETEdeleteReportTask/ad_report_task/:report_task_idThis call deletes the report task specified by the <b>report_task_id</b> path parameter. This method also deletes any reports generated by the report task.…

negative_keyword

  • POSTbulkCreateNegativeKeyword/bulk_create_negative_keyword<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTbulkUpdateNegativeKeyword/bulk_update_negative_keyword<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • GETgetNegativeKeywords/negative_keyword?ad_group_ids=string&campaign_ids=string&limit=string&negative_keyword_status=string&offset=string<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • POSTcreateNegativeKeyword/negative_keyword<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • GETgetNegativeKeyword/negative_keyword/:negative_keyword_id<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…
  • PUTupdateNegativeKeyword/negative_keyword/:negative_keyword_id<span class="tablenote"><b>Note:</b> This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA)…

item_price_markdown

  • POSTcreateItemPriceMarkdownPromotion/item_price_markdownThis method creates an <b>item price markdown promotion</b> (know simply as a "markdown promotion") where a discount amount is applied directly to the items…
  • GETgetItemPriceMarkdownPromotion/item_price_markdown/:promotion_idThis method returns the complete details of the item price markdown promotion that's indicated by the <b>promotion_id</b> path parameter. <br><br>Call <a…
  • PUTupdateItemPriceMarkdownPromotion/item_price_markdown/:promotion_idThis method updates the specified item price markdown promotion with the new configuration that you supply in the payload of the request. Specify the…
  • DELETEdeleteItemPriceMarkdownPromotion/item_price_markdown/:promotion_idThis method deletes the item price markdown promotion specified by the <b>promotion_id</b> path parameter. Call <a…

item_promotion

  • POSTcreateItemPromotion/item_promotionThis method creates an <b>item promotion</b>, where the buyer receives a discount when they meet the buying criteria that's set for the promotion. Known here…
  • GETgetItemPromotion/item_promotion/:promotion_idThis method returns the complete details of the threshold promotion specified by the <b>promotion_id</b> path parameter. Call <a…
  • PUTupdateItemPromotion/item_promotion/:promotion_idThis method updates the specified threshold promotion with the new configuration that you supply in the request. Indicate the promotion you want to update…
  • DELETEdeleteItemPromotion/item_promotion/:promotion_idThis method deletes the threshold promotion specified by the <b>promotion_id</b> path parameter. Call <a…

promotion

  • GETgetPromotions/promotion?limit=string&marketplace_id=string&offset=string&promotion_status=string&promotion_type=string&q=string&sort=stringThis method returns a list of a seller's undeleted promotions. <p>The call returns up to 200 currently-available promotions on the specified marketplace.…
  • GETgetListingSet/promotion/:promotion_id/get_listing_set?limit=string&offset=string&q=string&sort=string&status=stringThis method returns the set of listings associated with the <b>promotion_id</b> specified in the path parameter. Call <a…
  • POSTpausePromotion/promotion/:promotion_id/pauseThis method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from <code>RUNNING</code> to <code>PAUSED</code>.…
  • POSTresumePromotion/promotion/:promotion_id/resumeThis method restarts a threshold promotion that was previously paused and changes the state of the promotion from <code>PAUSED</code> to <code>RUNNING</code>.…

promotion_report

  • GETgetPromotionReports/promotion_report?limit=string&marketplace_id=string&offset=string&promotion_status=string&promotion_type=string&q=stringThis method generates a report that lists the seller's running, paused, and ended promotions for the specified eBay marketplace. The result set can be…

promotion_summary_report

  • GETgetPromotionSummaryReport/promotion_summary_report?marketplace_id=stringThis method generates a report that summarizes the seller's promotions for the specified eBay marketplace. The report returns information on…

API details

Base URL
https://api.ebay.com{basePath}
Authentication
OAuth 2.0 (authorization code, client credentials flows) with 2 scopes
Operations
69 operations on 53 pathsPOST 34GET 25PUT 5DELETE 5
Main resources
ad 16campaign 14ad_group 6keyword 6negative_keyword 6ad_report_task 4item_price_markdown 4item_promotion 4promotion 4ad_report_metadata 2
Response formats
application/json text/tab-separated-values
Description format
OpenAPI 3.0.0, API version v1.14.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Marketing API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Marketing API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getCampaigns” (GET /ad_campaign?campaign_name=string&campaign_status=string&end_date_range=string&funding_strategy=string&limit=string&offset=string&start_date_range=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Marketing API?

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… It is listed under E-commerce and has 69 endpoints.

Who publishes the Marketing API?

It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Marketing API?

Requests go to https://api.ebay.com{basePath}. Endpoint paths are added to this base URL.

How do I authenticate with the Marketing API?

With OAuth 2.0 (authorization code, client credentials flows) with 2 scopes.

How many endpoints does the Marketing API have?

69 operations on 53 paths (34 POST, 25 GET, 5 PUT, 5 DELETE). The largest groups are ad, campaign, ad_group, keyword.

Is forking the Marketing API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.