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.
Store Email Campaign allows sellers to create and send email campaigns to customers who have signed up to receive their newsletter. For more information on email campaigns, see Store Email Campaigns.
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.
ad
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
bulkCreateAdsByInventoryReference | POST | /ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference | Creates ads in bulk, based on SKUs or inventory item groups. | View bulkCreateAdsByInventoryReference - /ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference |
bulkCreateAdsByListingId | POST | /ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id | Creates ads in bulk, based on listing ID values. | View bulkCreateAdsByListingId - /ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id |
bulkDeleteAdsByInventoryReference | POST | /ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference | Deletes ads in bulk, based on SKUs or inventory item groups. | View bulkDeleteAdsByInventoryReference - /ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference |
bulkDeleteAdsByListingId | POST | /ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id | Deletes ads in bulk, based on listing ID values. | View bulkDeleteAdsByListingId - /ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id |
bulkUpdateAdsBidByInventoryReference | POST | /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference | Updates the bid percentage for ads in bulk, based on SKUs or inventory item groups. | View bulkUpdateAdsBidByInventoryReference - /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference |
bulkUpdateAdsBidByListingId | POST | /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id | Updates the bid percentage for CPS ads in bulk, based on listing ID values. | View bulkUpdateAdsBidByListingId - /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id |
bulkUpdateAdsStatus | POST | /ad_campaign/{campaign_id}/bulk_update_ads_status | Updates the status of CPC ads in bulk. | View bulkUpdateAdsStatus - /ad_campaign/{campaign_id}/bulk_update_ads_status |
bulkUpdateAdsStatusByListingId | POST | /ad_campaign/{campaign_id}/bulk_update_ads_status_by_listing_id | Updates the status of CPC ads in bulk, based on listing ID values. | View bulkUpdateAdsStatusByListingId - /ad_campaign/{campaign_id}/bulk_update_ads_status_by_listing_id |
createAdByListingId | POST | /ad_campaign/{campaign_id}/ad | Creates an ad based on a listing ID value and associates it with a campaign. | View createAdByListingId - /ad_campaign/{campaign_id}/ad |
createAdsByInventoryReference | POST | /ad_campaign/{campaign_id}/create_ads_by_inventory_reference | Creates an ad based on a SKU or an inventory item group and associates it with a campaign. | View createAdsByInventoryReference - /ad_campaign/{campaign_id}/create_ads_by_inventory_reference |
deleteAd | DELETE | /ad_campaign/{campaign_id}/ad/{ad_id} | Deletes an ad based on an ad ID and campaign ID. | View deleteAd - /ad_campaign/{campaign_id}/ad/{ad_id} |
deleteAdsByInventoryReference | POST | /ad_campaign/{campaign_id}/delete_ads_by_inventory_reference | Deletes ads from a campaign based on a SKU or an inventory item group. | View deleteAdsByInventoryReference - /ad_campaign/{campaign_id}/delete_ads_by_inventory_reference |
getAd | GET | /ad_campaign/{campaign_id}/ad/{ad_id} | Retrieves an ad. | View getAd - /ad_campaign/{campaign_id}/ad/{ad_id} |
getAds | GET | /ad_campaign/{campaign_id}/ad | Retrieves all ads for a campaign, or specific ads in the campaign according to search criteria. | View getAds - /ad_campaign/{campaign_id}/ad |
getAdsByInventoryReference | GET | /ad_campaign/{campaign_id}/get_ads_by_inventory_reference | Retrieves ads for a campaign, based on listing IDS, SKUs or inventory item groups. | View getAdsByInventoryReference - /ad_campaign/{campaign_id}/get_ads_by_inventory_reference |
updateBid | POST | /ad_campaign/{campaign_id}/ad/{ad_id}/update_bid | Updates the bid percentage for a CPS ad. | View updateBid - /ad_campaign/{campaign_id}/ad/{ad_id}/update_bid |
ad_group
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
createAdGroup | POST | /ad_campaign/{campaign_id}/ad_group | Creates an ad group. | View createAdGroup - /ad_campaign/{campaign_id}/ad_group |
getAdGroup | GET | /ad_campaign/{campaign_id}/ad_group/{ad_group_id} | Retrieves an ad group. | View getAdGroup - /ad_campaign/{campaign_id}/ad_group/{ad_group_id} |
getAdGroups | GET | /ad_campaign/{campaign_id}/ad_group | Retrieves ad groups. | View getAdGroups - /ad_campaign/{campaign_id}/ad_group |
suggestBids | POST | /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_bids | Retrieves suggested bid values for a set of keywords in an ad group. | View suggestBids - /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_bids |
suggestKeywords | POST | /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_keywords | Retrieves suggested keywords for an ad group. | View suggestKeywords - /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_keywords |
updateAdGroup | PUT | /ad_campaign/{campaign_id}/ad_group/{ad_group_id} | Updates an ad group. | View updateAdGroup - /ad_campaign/{campaign_id}/ad_group/{ad_group_id} |
campaign
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
cloneCampaign | POST | /ad_campaign/{campaign_id}/clone | Copies an ended general strategy campaign. | View cloneCampaign - /ad_campaign/{campaign_id}/clone |
createCampaign | POST | /ad_campaign | Creates an ad campaign. | View createCampaign - /ad_campaign |
deleteCampaign | DELETE | /ad_campaign/{campaign_id} | Deletes an ended ad campaign. | View deleteCampaign - /ad_campaign/{campaign_id} |
endCampaign | POST | /ad_campaign/{campaign_id}/end | Ends an active or paused ad campaign. | View endCampaign - /ad_campaign/{campaign_id}/end |
findCampaignByAdReference | GET | /ad_campaign/find_campaign_by_ad_reference | Retrieves general strategy ad campaign by listing ID, SKU, or inventory item group. | View findCampaignByAdReference - /ad_campaign/find_campaign_by_ad_reference |
getCampaign | GET | /ad_campaign/{campaign_id} | Retrieves an ad campaign by campaign ID. | View getCampaign - /ad_campaign/{campaign_id} |
getCampaignByName | GET | /ad_campaign/get_campaign_by_name | Retrieves an ad campaign by campaign name. | View getCampaignByName - /ad_campaign/get_campaign_by_name |
getCampaigns | GET | /ad_campaign | Retrieves one or more ad campaigns based on search criteria. | View getCampaigns - /ad_campaign |
launchCampaign | POST | /ad_campaign/{campaign_id}/launch | Launches a Quick Setup campaign in draft status. | View launchCampaign - /ad_campaign/{campaign_id}/launch |
pauseCampaign | POST | /ad_campaign/{campaign_id}/pause | Pauses an active ad campaign. | View pauseCampaign - /ad_campaign/{campaign_id}/pause |
resumeCampaign | POST | /ad_campaign/{campaign_id}/resume | Resumes a paused ad campaign. | View resumeCampaign - /ad_campaign/{campaign_id}/resume |
setupQuickCampaign | POST | /ad_campaign/setup_quick_campaign | Creates a draft of a priority strategy campaign with one step. | View setupQuickCampaign - /ad_campaign/setup_quick_campaign |
suggestBudget | GET | /ad_campaign/suggest_budget | Retrieves the suggested daily budget for an offsite ad campaign. | View suggestBudget - /ad_campaign/suggest_budget |
suggestItems | GET | /ad_campaign/{campaign_id}/suggest_items | Retrieves listings that are possible candidates to be added to a priority strategy campaign. | View suggestItems - /ad_campaign/{campaign_id}/suggest_items |
suggestMaxCpc | POST | /ad_campaign/suggest_max_cpc | Retrieves suggested maxCPC value for a smart targeting campaign. | View suggestMaxCpc - /ad_campaign/suggest_max_cpc |
updateAdRateStrategy | POST | /ad_campaign/{campaign_id}/update_ad_rate_strategy | Updates the ad rate strategy for a general strategy campaign. | View updateAdRateStrategy - /ad_campaign/{campaign_id}/update_ad_rate_strategy |
updateBiddingStrategy | POST | /ad_campaign/{campaign_id}/update_bidding_strategy | This method allows sellers to change their bidding strategy for a specified Cost Per Click (CPC) campaign. | View updateBiddingStrategy - /ad_campaign/{campaign_id}/update_bidding_strategy |
updateCampaignBudget | POST | /ad_campaign/{campaign_id}/update_campaign_budget | Updates the daily budget for a priority strategy campaign. | View updateCampaignBudget - /ad_campaign/{campaign_id}/update_campaign_budget |
updateCampaignIdentification | POST | /ad_campaign/{campaign_id}/update_campaign_identification | Updates an ad campaign's name, start date, and/or end date. | View updateCampaignIdentification - /ad_campaign/{campaign_id}/update_campaign_identification |
keyword
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
bulkCreateKeyword | POST | /ad_campaign/{campaign_id}/bulk_create_keyword | Creates a set of keywords for one or more ad groups in an existing priority strategy campaign. | View bulkCreateKeyword - /ad_campaign/{campaign_id}/bulk_create_keyword |
bulkUpdateKeyword | POST | /ad_campaign/{campaign_id}/bulk_update_keyword | Updates the status and/or bid rates for one or more keywords in a priority strategy campaign. | View bulkUpdateKeyword - /ad_campaign/{campaign_id}/bulk_update_keyword |
createKeyword | POST | /ad_campaign/{campaign_id}/keyword | Creates a keyword for an ad group in a priority strategy campaign. | View createKeyword - /ad_campaign/{campaign_id}/keyword |
getKeyword | GET | /ad_campaign/{campaign_id}/keyword/{keyword_id} | Retrieves details on a priority strategy campaign's keyword. | View getKeyword - /ad_campaign/{campaign_id}/keyword/{keyword_id} |
getKeywords | GET | /ad_campaign/{campaign_id}/keyword | Retrieves one or more keywords in a priority strategy campaign based on search criteria. | View getKeywords - /ad_campaign/{campaign_id}/keyword |
updateKeyword | PUT | /ad_campaign/{campaign_id}/keyword/{keyword_id} | Updates the status and/or bid rate for a keyword in a priority strategy campaign. | View updateKeyword - /ad_campaign/{campaign_id}/keyword/{keyword_id} |
negative_keyword
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
bulkCreateNegativeKeyword | POST | /bulk_create_negative_keyword | Creates a set of negative keywords for one for more ad groups in an existing priority strategy campaign. | View bulkCreateNegativeKeyword - /bulk_create_negative_keyword |
bulkUpdateNegativeKeyword | POST | /bulk_update_negative_keyword | Updates the status and/or bid rates for one or more keywords in a priority strategy campaign. | View bulkUpdateNegativeKeyword - /bulk_update_negative_keyword |
createNegativeKeyword | POST | /negative_keyword | Creates a negative keyword for an ad group in a priority strategy campaign. | View createNegativeKeyword - /negative_keyword |
getNegativeKeyword | GET | /negative_keyword/{negative_keyword_id} | Retrieves details on a priority strategy campaign's negative keyword. | View getNegativeKeyword - /negative_keyword/{negative_keyword_id} |
getNegativeKeywords | GET | /negative_keyword | Retrieves one or more keywords in a priority strategy campaign based on search criteria. | View getNegativeKeywords - /negative_keyword |
updateNegativeKeyword | PUT | /negative_keyword/{negative_keyword_id} | Updates the status and/or bid rate for a keyword in a priority strategy campaign. | View updateNegativeKeyword - /negative_keyword/{negative_keyword_id} |
ad_report
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
getReport | GET | /ad_report/{report_id} | Downloads a Promoted Listings report. | View getReport - /ad_report/{report_id} |
ad_report_metadata
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
getReportMetadata | GET | /ad_report_metadata | Retrieves metadata for each Promoted Listings report type. | View getReportMetadata - /ad_report_metadata |
getReportMetadataForReportType | GET | /ad_report_metadata/{report_type} | Retrieves metadata for a specific Promoted Listings report type. | View getReportMetadataForReportType - /ad_report_metadata/{report_type} |
ad_report_task
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
createReportTask | POST | /ad_report_task | Configures the settings and metrics of a Promoted Listings report that will be downloaded with the getReport method. | View createReportTask - /ad_report_task |
deleteReportTask | DELETE | /ad_report_task/{report_task_id} | Deletes a Promoted Listings report task. | View deleteReportTask - /ad_report_task/{report_task_id} |
getReportTask | GET | /ad_report_task/{report_task_id} | Retrieves the details on a Promoted Listings report task. | View getReportTask - /ad_report_task/{report_task_id} |
getReportTasks | GET | /ad_report_task | Retrieves details on all current Promoted Listings reports, with an option to filter by report status. | View getReportTasks - /ad_report_task |
item_price_markdown
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
createItemPriceMarkdownPromotion | POST | /item_price_markdown | Creates a markdown discount and applies it to one or more active listings. | View createItemPriceMarkdownPromotion - /item_price_markdown |
deleteItemPriceMarkdownPromotion | DELETE | /item_price_markdown/{promotion_id} | Deletes an inactive markdown discount. | View deleteItemPriceMarkdownPromotion - /item_price_markdown/{promotion_id} |
getItemPriceMarkdownPromotion | GET | /item_price_markdown/{promotion_id} | Retrieves details on a markdown discount. | View getItemPriceMarkdownPromotion - /item_price_markdown/{promotion_id} |
updateItemPriceMarkdownPromotion | PUT | /item_price_markdown/{promotion_id} | Updates an existing markdown discount. | View updateItemPriceMarkdownPromotion - /item_price_markdown/{promotion_id} |
item_promotion
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
createItemPromotion | POST | /item_promotion | Creates an item discount and applies it to one or more active listings. | View createItemPromotion - /item_promotion |
deleteItemPromotion | DELETE | /item_promotion/{promotion_id} | Deletes an inactive item discount. | View deleteItemPromotion - /item_promotion/{promotion_id} |
getItemPromotion | GET | /item_promotion/{promotion_id} | Retrieves the details on an item discount. | View getItemPromotion - /item_promotion/{promotion_id} |
updateItemPromotion | PUT | /item_promotion/{promotion_id} | Updates an existing item discount. | View updateItemPromotion - /item_promotion/{promotion_id} |
promotion
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
getListingSet | GET | /promotion/{promotion_id}/get_listing_set | Retrieves a set of listings linked to an item discount. | View getListingSet - /promotion/{promotion_id}/get_listing_set |
getPromotions | GET | /promotion | Retrieves one or more of a seller's item discounts for an eBay marketplace that match search criteria. | View getPromotions - /promotion |
pausePromotion | POST | /promotion/{promotion_id}/pause | Pauses a RUNNING item discount. | View pausePromotion - /promotion/{promotion_id}/pause |
resumePromotion | POST | /promotion/{promotion_id}/resume | Restarts a PAUSED item discount. | View resumePromotion - /promotion/{promotion_id}/resume |
promotion_report
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
getPromotionReports | GET | /promotion_report | Retrieves detailed metrics for one or more of a seller's item discounts for an eBay marketplace that match search criteria. | View getPromotionReports - /promotion_report |
promotion_summary_report
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
getPromotionSummaryReport | GET | /promotion_summary_report | Retrieves summarized sales data for all of a seller's non-ended item discounts for a specified marketplace. | View getPromotionSummaryReport - /promotion_summary_report |
email_campaign
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
createEmailCampaign | POST | /email_campaign | Creates a Store email campaign. | View createEmailCampaign - /email_campaign |
deleteEmailCampaign | DELETE | /email_campaign/{email_campaign_id} | Deletes a Store email campaign. | View deleteEmailCampaign - /email_campaign/{email_campaign_id} |
getAudiences | GET | /email_campaign/audience | Retrieves all of a seller's audience groups for a specified Store email campaign type. | View getAudiences - /email_campaign/audience |
getEmailCampaign | GET | /email_campaign/{email_campaign_id} | Retrieves a Store email campaign. | View getEmailCampaign - /email_campaign/{email_campaign_id} |
getEmailCampaigns | GET | /email_campaign | Retrieves a list of Store email campaigns that match search criteria. | View getEmailCampaigns - /email_campaign |
getEmailPreview | GET | /email_campaign/{email_campaign_id}/email_preview | Retrieves the raw HTML content of the email body associated with a Store email campaign. | View getEmailPreview - /email_campaign/{email_campaign_id}/email_preview |
getEmailReport | GET | /email_campaign/report | Retrieves a seller's email campaign performance report for a specified time period. | View getEmailReport - /email_campaign/report |
updateEmailCampaign | PUT | /email_campaign/{email_campaign_id} | Updates an existing Store email campaign. | View updateEmailCampaign - /email_campaign/{email_campaign_id} |