marketing APIv1.4.0

API Reference : Resources

The Marketing API offers two platforms that let sellers 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 of the sales price. For complete details, see Promoted Listings.
  • Item promotions give 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 item promotion teasers throughout buyer flows. For complete details, see Item promotions.

Marketing reports, on both the Promoted Listings and item promotions 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 specific to Promoted Listings and item promotions, before they can make request 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 Marketing Overview.

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

ad

Method NameHTTP MethodPathSummarySamples
bulkCreateAdsByInventoryReferencePOST
/ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference
Creates ads for a list of inventory reference IDs and associates the ads with a campaign.View bulkCreateAdsByInventoryReference - /ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference
bulkCreateAdsByListingIdPOST
/ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id
Creates ads based on a set of listing IDs and associates the ads with a campaign.View bulkCreateAdsByListingId - /ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id
bulkDeleteAdsByInventoryReferencePOST
/ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference
Deletes a set of ads from a campaign by inventory reference ID.View bulkDeleteAdsByInventoryReference - /ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference
bulkDeleteAdsByListingIdPOST
/ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id
Deletes a set of ads from a campaign by listing ID.View bulkDeleteAdsByListingId - /ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id
bulkUpdateAdsBidByInventoryReferencePOST
/ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference
Updates the ad bid for items in a campaign by inventory reference ID.View bulkUpdateAdsBidByInventoryReference - /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference
bulkUpdateAdsBidByListingIdPOST
/ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id
Updates the ad bid for items in a campaign by listing ID.View bulkUpdateAdsBidByListingId - /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id
createAdByListingIdPOST
/ad_campaign/{campaign_id}/ad
Creates an ad using a listing ID and associates it with a campaign.

View createAdByListingId - /ad_campaign/{campaign_id}/ad
createAdsByInventoryReferencePOST
/ad_campaign/{campaign_id}/create_ads_by_inventory_reference
Creates a set of ads by inventory reference ID and associates them with a campaign.View createAdsByInventoryReference - /ad_campaign/{campaign_id}/create_ads_by_inventory_reference
deleteAdDELETE
/ad_campaign/{campaign_id}/ad/{ad_id}
Deletes an ad by ad ID and campaign ID.View deleteAd - /ad_campaign/{campaign_id}/ad/{ad_id}
deleteAdsByInventoryReferencePOST
/ad_campaign/{campaign_id}/delete_ads_by_inventory_reference
Deletes ads from a campaign by inventory reference ID.View deleteAdsByInventoryReference - /ad_campaign/{campaign_id}/delete_ads_by_inventory_reference
getAdGET
/ad_campaign/{campaign_id}/ad/{ad_id}
Retrieves an ad by ad ID and campaign ID.View getAd - /ad_campaign/{campaign_id}/ad/{ad_id}
getAdsGET
/ad_campaign/{campaign_id}/ad
Retrieves all the ads associated with a campaign.
You can filter and paginate the result set.
View getAds - /ad_campaign/{campaign_id}/ad
getAdsByInventoryReferenceGET
/ad_campaign/{campaign_id}/get_ads_by_inventory_reference
Retrieves ads from a campaign by inventory reference ID.View getAdsByInventoryReference - /ad_campaign/{campaign_id}/get_ads_by_inventory_reference
updateBidPOST
/ad_campaign/{campaign_id}/ad/{ad_id}/update_bid
Updates the bid for an ad ID by campaign ID.View updateBid - /ad_campaign/{campaign_id}/ad/{ad_id}/update_bid

campaign

Method NameHTTP MethodPathSummarySamples
cloneCampaignPOST
/ad_campaign/{campaign_id}/clone
Clones a selection-rule based campaign.View cloneCampaign - /ad_campaign/{campaign_id}/clone
createCampaignPOST
/ad_campaign
Creates a Promoted Listings ad campaign.View createCampaign - /ad_campaign
deleteCampaignDELETE
/ad_campaign/{campaign_id}
Deletes a campaign that has ended by campaign ID.View deleteCampaign - /ad_campaign/{campaign_id}
endCampaignPOST
/ad_campaign/{campaign_id}/end
Ends a RUNNING or PAUSED campaign.
You can clone ended campaigns with cloneCampaign.
View endCampaign - /ad_campaign/{campaign_id}/end
findCampaignByAdReferenceGET
/ad_campaign/find_campaign_by_ad_reference
Retrieves a campaign by listing ID, or by inventory reference ID and reference type pair.View findCampaignByAdReference - /ad_campaign/find_campaign_by_ad_reference
getCampaignGET
/ad_campaign/{campaign_id}
Retrieves the details of a campaign by campaign ID.View getCampaign - /ad_campaign/{campaign_id}
getCampaignByNameGET
/ad_campaign/get_campaign_by_name
Retrieves the the details of a campaign by campaign name.View getCampaignByName - /ad_campaign/get_campaign_by_name
getCampaignsGET
/ad_campaign
Retrieves the details of all of a seller's campaigns.
You can filter and paginate the result set.
View getCampaigns - /ad_campaign
pauseCampaignPOST
/ad_campaign/{campaign_id}/pause
Pauses a RUNNING campaign.View pauseCampaign - /ad_campaign/{campaign_id}/pause
resumeCampaignPOST
/ad_campaign/{campaign_id}/resume
Resumes a PAUSED campaign.View resumeCampaign - /ad_campaign/{campaign_id}/resume
updateCampaignIdentificationPOST
/ad_campaign/{campaign_id}/update_campaign_identification
Updates a campaign's name, start date, and end date by campaign ID.View updateCampaignIdentification - /ad_campaign/{campaign_id}/update_campaign_identification

ad_report

Method NameHTTP MethodPathSummarySamples
getReportGET
/ad_report/{report_id}
Downloads a Promoted Listings report by ID.View getReport - /ad_report/{report_id}

ad_report_metadata

Method NameHTTP MethodPathSummarySamples
getReportMetadataGET
/ad_report_metadata
Retrieves metadata that details the fields returned in all Promoted Listings reports.View getReportMetadata - /ad_report_metadata
getReportMetadataForReportTypeGET
/ad_report_metadata/{report_type}
Retrieves metadata that details the fields returned in a specific Promoted Listings report.View getReportMetadataForReportType - /ad_report_metadata/{report_type}

ad_report_task

Method NameHTTP MethodPathSummarySamples
createReportTaskPOST
/ad_report_task
Creates a report task, which generates a Promoted Listings report.View createReportTask - /ad_report_task
deleteReportTaskDELETE
/ad_report_task/{report_task_id}
Deletes a Promoted Listings report task, and any associated reports, by ID.View deleteReportTask - /ad_report_task/{report_task_id}
getReportTaskGET
/ad_report_task/{report_task_id}
Retrieves the details on a Promoted Listings report task by ID.View getReportTask - /ad_report_task/{report_task_id}
getReportTasksGET
/ad_report_task
Retrieves a detailed list of the seller's report tasks.
You can filter and paginate the result set.
View getReportTasks - /ad_report_task

item_promotion

Method NameHTTP MethodPathSummarySamples
createItemPromotionPOST
/item_promotion
Creates an item promotion.View createItemPromotion - /item_promotion
deleteItemPromotionDELETE
/item_promotion/{promotion_id}
Deletes a promotion, except any that are RUNNING.View deleteItemPromotion - /item_promotion/{promotion_id}
getItemPromotionGET
/item_promotion/{promotion_id}
Retrieves a promotion's details by promotion ID.View getItemPromotion - /item_promotion/{promotion_id}
updateItemPromotionPUT
/item_promotion/{promotion_id}
Updates a promotion's details by promotion ID.View updateItemPromotion - /item_promotion/{promotion_id}

promotion

Method NameHTTP MethodPathSummarySamples
getListingSetGET
/promotion/{promotion_id}/get_listing_set
Retrieves the set of listings linked to a promotion ID.View getListingSet - /promotion/{promotion_id}/get_listing_set
getPromotionsGET
/promotion
Retrieves a seller's promotions by marketplace.View getPromotions - /promotion
pausePromotionPOST
/promotion/{promotion_id}/pause
Pauses a RUNNING promotion.View pausePromotion - /promotion/{promotion_id}/pause
resumePromotionPOST
/promotion/{promotion_id}/resume
Restarts a PAUSED promotion.View resumePromotion - /promotion/{promotion_id}/resume

promotion_report

Method NameHTTP MethodPathSummarySamples
getPromotionReportsGET
/promotion_report
Returns a promotion report by marketplace.View getPromotionReports - /promotion_report

promotion_summary_report

Method NameHTTP MethodPathSummarySamples
getPromotionSummaryReportGET
/promotion_summary_report
Returns a promotion summary report by marketplace.View getPromotionSummaryReport - /promotion_summary_report