Open documentation ↗Overview
<p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:</p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i> for the products they want to promote. eBay displays the ads in search results and in other marketing modules as <b>SPONSORED</b> 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 <a href="/api-docs/sell/static/marketing/pl-landing.html">Promoted Listings playbook</a>.</li><li><b>Promotions Manager</b> 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 <i>teasers</i> throughout buyer flows. For complete details, see <a href="/api-docs/sell/static/marketing/promotions-manager.html">Promotions Manager</a>.</li></ul> <p><b>Marketing reports</b>, 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.</p> <p class="tablenote"><b>Important!</b> Sellers must have an active eBay Store subscription, and they must accept the <b>Terms and Conditions</b> 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 <a href="/api-docs/sell/marketing/static/overview.html#PL-requirements">Promoted Listings</a> and <a href="/api-docs/sell/marketing/static/overview.html#PM-requirements">Promotions Manager</a>.</p> <p>The table below lists all the Marketing API calls grouped by resource.</p>
Marketing API is a shopping API from ebay.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 69 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Shopping
- Version
- v1.14.0
- Endpoints
- 69
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-05
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /ad_campaign | 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 campaig |
| POST | /ad_campaign | This 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 li |
| GET | /ad_campaign/find_campaign_by_ad_reference | This method retrieves the campaigns containing the listing that is specified using either a listing ID, or an inventory reference ID and inventory reference typ |
| GET | /ad_campaign/get_campaign_by_name | This 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 must |
| GET | /ad_campaign/{campaign_id} | This 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 c |
| DELETE | /ad_campaign/{campaign_id} | This method deletes the campaign specified by the <code>campaign_id</code> query parameter.<br /><br /><span class="tablenote"><b>Note: </b> You can only delete |
| GET | /ad_campaign/{campaign_id}/ad | This method retrieves Promoted Listings ads that are associated with listings created with either the <a href="/Devzone/XML/docs/Reference/eBay/index.html" titl |
| POST | /ad_campaign/{campaign_id}/ad | This method adds a listing to an existing Promoted Listings campaign using a <b>listingId</b> value generated by the <a href="/Devzone/XML/docs/Reference/eBay/i |
| GET | /ad_campaign/{campaign_id}/ad/{ad_id} | This 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> < |
| DELETE | /ad_campaign/{campaign_id}/ad/{ad_id} | This 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 ad |
| POST | /ad_campaign/{campaign_id}/ad/{ad_id}/update_bid | This 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 <b>campaign_i |
| GET | /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) prog |
| POST | /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) prog |
| GET | /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) prog |
| PUT | /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) prog |
| POST | /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) prog |
| POST | /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) prog |
| POST | /ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference | This method adds multiple listings that are managed with the <a href="/api-docs/sell/inventory/resources/methods" title="Inventory API Reference">Inventory API< |
| POST | /ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id | This method adds multiple listings to an existing Promoted Listings campaign using <b>listingId</b> values generated by the <a href="/Devzone/XML/docs/Reference |
| POST | /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) prog |
| POST | /ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference | This method works with listings created with the <a href="/api-docs/sell/inventory/resources/methods" title="Inventory API Reference">Inventory API</a>.<br /><b |
| POST | /ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id | This 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> o |
| POST | /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference | This 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 t |
| POST | /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id | This 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 t |
| POST | /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) prog |
| POST | /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) prog |
| POST | /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) prog |
| POST | /ad_campaign/{campaign_id}/clone | This 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 define |
| POST | /ad_campaign/{campaign_id}/create_ads_by_inventory_reference | This 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 an |
| POST | /ad_campaign/{campaign_id}/delete_ads_by_inventory_reference | This method works with listings that are managed with the <a href="/api-docs/sell/inventory/resources/methods" title="Inventory API Reference">Inventory API</a> |
| POST | /ad_campaign/{campaign_id}/end | This 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. < |
| GET | /ad_campaign/{campaign_id}/get_ads_by_inventory_reference | This method retrieves Promoted Listings ads associated with listings that are managed with the <a href="/api-docs/sell/inventory/resources/methods" title="Inven |
| GET | /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) prog |
| POST | /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) prog |
| GET | /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) prog |
| PUT | /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) prog |
| POST | /ad_campaign/{campaign_id}/pause | This method pauses an active (RUNNING) campaign. <p>You can restart the campaign by calling <a href="/api-docs/sell/marketing/resources/campaign/methods/resume |
| POST | /ad_campaign/{campaign_id}/resume | This 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 p |
| GET | /ad_campaign/{campaign_id}/suggest_items | <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) prog |
| POST | /ad_campaign/{campaign_id}/update_ad_rate_strategy | 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 mode |
| POST | /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) prog |
| POST | /ad_campaign/{campaign_id}/update_campaign_identification | This 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 UR |
| GET | /ad_report/{report_id} | This call downloads the report as specified by the <b>report_id</b> path parameter. <br><br>Call <a href="/api-docs/sell/marketing/resources/ad_report_task/met |
| GET | /ad_report_metadata | This call retrieves information that details the fields used in each of the Promoted Listings reports. Use the returned information to configure the different t |
| GET | /ad_report_metadata/{report_type} | This 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 met |
| GET | /ad_report_task | This 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 re |
| POST | /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 returned |
| GET | /ad_report_task/{report_task_id} | This 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 includes |
| DELETE | /ad_report_task/{report_task_id} | This 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. <p> |
| POST | /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) prog |
| POST | /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) prog |
| POST | /item_price_markdown | This 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 inc |
| GET | /item_price_markdown/{promotion_id} | This 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 href=" |
| PUT | /item_price_markdown/{promotion_id} | 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 |
| DELETE | /item_price_markdown/{promotion_id} | This method deletes the item price markdown promotion specified by the <b>promotion_id</b> path parameter. Call <a href="/api-docs/sell/marketing/resources/prom |
| POST | /item_promotion | This 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 as |
| GET | /item_promotion/{promotion_id} | This method returns the complete details of the threshold promotion specified by the <b>promotion_id</b> path parameter. Call <a href="/api-docs/sell/marketing/ |
| PUT | /item_promotion/{promotion_id} | 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 |
| DELETE | /item_promotion/{promotion_id} | This method deletes the threshold promotion specified by the <b>promotion_id</b> path parameter. Call <a href="/api-docs/sell/marketing/resources/promotion/meth |
| GET | /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) prog |
| POST | /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) prog |
| GET | /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) prog |
| PUT | /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) prog |
| GET | /promotion | This method returns a list of a seller's undeleted promotions. <p>The call returns up to 200 currently-available promotions on the specified marketplace. While |
| GET | /promotion/{promotion_id}/get_listing_set | This method returns the set of listings associated with the <b>promotion_id</b> specified in the path parameter. Call <a href="/api-docs/sell/marketing/resource |
| POST | /promotion/{promotion_id}/pause | This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from <code>RUNNING</code> to <code>PAUSED</code>. Pau |
| POST | /promotion/{promotion_id}/resume | This method restarts a threshold promotion that was previously paused and changes the state of the promotion from <code>PAUSED</code> to <code>RUNNING</code>. O |
| GET | /promotion_report | 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 |
| GET | /promotion_summary_report | This method generates a report that summarizes the seller's promotions for the specified eBay marketplace. The report returns information on <code>RUNNING</code |
Questions
Does the Marketing API API need an API key?
Yes. The Marketing API API uses OAuth authentication; the documentation explains how to get credentials.
Does the Marketing API API support HTTPS?
Yes, the Marketing API API is served over HTTPS.
How many endpoints does the Marketing API API have?
Its OpenAPI description lists 69 endpoints in version v1.14.0. All of them are shown on this page.
What are alternatives to the Marketing API API?
Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.
Similar shopping APIs
Compare alternatives →Etsy
ShoppingManage shop and interact with listings
OAuth
eBay
ShoppingSell and Buy on eBay
OAuth
Flipkart Marketplace
ShoppingProduct listing management, Order Fulfilment in the Flipkart Marketplace
OAuthCORS
Inventory Management
ShoppingMaintaining up-to-date inventory for your items on Walmart.com ensures a great experience for your customers and greater sales opportunities for you.
No auth7 endpoints
Intel Product Catalogue Service
ShoppingThis is the documentation for PIM Micro services. In order to use this tool you need to have Basic Auth credentials and a client id. If you dont have one, please make sure to request one by sending an email to the PIM MS team: [[email protected]](mailto:[email protected]?subject=PIMServices)
API key4 endpoints
Item API
ShoppingPlease make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.
No auth6 endpoints
Listed from APIs.guru (CC0).