eBay Marketing APIVersion 1.3.0

Call Index

This API Reference describes the elements and attributes for each call in the Marketing API.

The Marketing API lets sellers manage the lifecycle (create, view, update, and delete) of their Promotions Manager Promotions and their Promoted Listings. In addition to lifecycle management, the API enables seller's to generated reports for their Promotions and Promoted Listings.

Promotions Manager Promotions are seller promotions, such as Buy 1 Get 1 and are more visible on the site through teasers prominently placed throughout the buyer flows, such as in search results, the item page, and through the cart and checkout flow.

Promoted Listings are purchased search advertising that are branded as SPONSORED and appear prominently in the search results and in other marketing modules on the site. Sellers specify the percentage of the sale price that they will be charged by eBay when the listing sells via a promoted listing. The sale of an item via a promoted listing is the event that triggers the seller fee. If the item does not sell, the seller owes nothing. See Promoted listings in the Selling Integration Guide for details about the Promoted Listings fees.

Seller Requirements: To use this API, the seller must have accepted the Promotions and/or Promoted Listings Terms and Conditions on the site where they want to create promotions or promoted listings, and must have an active eBay Store subscription. There are also listings requirements and site restrictions. To view all the requirements/restrictions, see the Marketing Overview.

 

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


Field Index      Enumeration Index      Type Index

Call Summary Samples
AD
  Bulk Create Ads By Inventory Reference
POST /ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference
Creates ads based on a list of seller inventory references and associates the ad with the specified campaign.

A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).
view
  Bulk Create Ads By Listing ID
POST /ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id
Creates ads based on a list of eBay listing IDs and associates the ads with the specified campaign.

Note: eBay listingId is called itemId in the traditional APIs, such as the Trading API or Finding API.

view
  Bulk Delete Ads By Inventory Reference
POST /ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference
Deletes ads from the specified campaign using a list of seller inventory reference IDs.

A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).
view
  Bulk Delete Ads By Listing ID
POST /ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id
Removes ads from the specified campaign using a list eBay listing IDs.

Note: eBay listingId is called itemId in the traditional APIs, such as the Trading API or Finding API.

view
  Bulk Update Ad Bids By Inventory Reference
POST /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference
Updates (replaces) the Ad bid for the list of seller inventory references in the specified campaign.

A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).
view
  Bulk Update Ad Bids By Listing ID
POST /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id
Updates (replaces) the ads for the specified campaign based on a list of eBay listing IDs.

Note: eBay listingId is called itemId in the traditional APIs, such as the Trading API or Finding API.

view
  Create Ad By Listing ID
POST /ad_campaign/{campaign_id}/ad
Creates an ad for the eBay listing ID and associates the ad with the specified campaign.

Note: eBay listingId is called itemId in the traditional APIs, such as the Trading API or Finding API.

view
  Create Ads By Inventory Reference
POST /ad_campaign/{campaign_id}/create_ads_by_inventory_reference
Creates an ad for the specified seller inventory reference ID and associates it with the specified campaign.

A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).
view
  Delete Ad by ID
DELETE /ad_campaign/{campaign_id}/ad/{ad_id}
Deletes the specified ad using the ad ID and campaign ID. view
  Delete Ads By Inventory Reference
POST /ad_campaign/{campaign_id}/delete_ads_by_inventory_reference
Deletes ads based on a list of seller inventory reference IDs from the specified campaign.

A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).
view
  Get Ad by ID
GET /ad_campaign/{campaign_id}/ad/{ad_id}
Retrieves the specified ad using the ad ID and campaign ID. view
  Get Ads
GET /ad_campaign/{campaign_id}/ad
Retrieves all the ads associated with the specified campaign. view
  Get Ads By Inventory Reference
GET /ad_campaign/{campaign_id}/get_ads_by_inventory_reference
Retrieves ads using the seller's inventory reference IDs from the specified campaign.

A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).
view
  Update Bid
POST /ad_campaign/{campaign_id}/ad/{ad_id}/update_bid
Updates the bid for the specified ad associated with the specified campaign. view
AD_REPORT
  Get Specific Report
GET /ad_report/{report_id}
Downloads the specified report. view
AD_REPORT_METADATA
  Get Metadata For All Reports
GET /ad_report_metadata
Retrieves the metadata for all reports. view
  Get Metadata For a Report Type
GET /ad_report_metadata/{report_type}
Retrieves the metadata for a specific report. view
AD_REPORT_TASK
  Create Report Task
POST /ad_report_task
Creates a report task. A report task contains the definition of a report and is what generates the report based on that definition. You retrieve a report task using the Get Specific Report Task or the Get Report Tasks calls. view
  Delete Specific Report Task
DELETE /ad_report_task/{report_task_id}
Deletes the specified report task. view
  Get Report Tasks
GET /ad_report_task
Retrieves the report tasks based on filters. view
  Get Specific Report Task
GET /ad_report_task/{report_task_id}
Retrieves the criteria, such as dimensions, metrics, listing, etc., and the generation rules, such as starting and ending date, for the specified report task. view
CAMPAIGN
  Clone Campaign
POST /ad_campaign/{campaign_id}/clone
Clones a criterion (selection rule) based campaign. To clone a campaign, the campaign must be ended. view
  Create Campaign
POST /ad_campaign
Creates a campaign. You can create a campaign using a set of rules or pass in a list of seller inventory reference IDs or eBay listing IDs.

A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).

Note: eBay listingId is called itemId in the traditional APIs, such as the Trading API or Finding API.

view
  Delete Campaign
DELETE /ad_campaign/{campaign_id}
Deletes an ended campaign using the campaign ID. view
  End Campaign
POST /ad_campaign/{campaign_id}/end
Ends an active (RUNNING) or paused campaign. Campaigns that are ended can be cloned to create a new campaign using the Clone Campaign call. view
  Find Campaign By Ad Reference
GET /ad_campaign/find_campaign_by_ad_reference
Retrieves the campaign using an eBay listing ID or a seller's inventory reference ID and inventory reference type.

eBay listing IDs are generated when the listing is created on eBay. A seller inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (seller-defined ID for an inventory item group, an entity that is used in the Inventory API to create a multiple-variation listing).

Note: eBay listingId is called itemId in the traditional APIs, such as the Trading API or Finding API.

view
  Get All Campaigns
GET /ad_campaign
Retrieves all your campaigns. You can apply filters to reduce the result set. view
  Get Campaign By Name
GET /ad_campaign/get_campaign_by_name
Retrieves the campaign by its name. This search is case sensitive and must be an exact match. view
  Get Campaign by ID
GET /ad_campaign/{campaign_id}
Retrieves the campaign by campaign ID. view
  Pause Campaign
POST /ad_campaign/{campaign_id}/pause
Pauses an active (RUNNING) campaign. view
  Resume Campaign
POST /ad_campaign/{campaign_id}/resume
Resumes a paused campaign. view
  Update Campaign IDentification
POST /ad_campaign/{campaign_id}/update_campaign_identification
Updates (replaces) the campaign name, start date, and end date. view
ITEM_PROMOTION
  Create an Item Promotion
POST /item_promotion
Creates a promotion. Currently, eBay supports only order-discount promotions. view
  Delete an Item Promotion
DELETE /item_promotion/{promotion_id}
Deletes any promotion, except a promotion that is active (RUNNING). view
  Get an Item Promotion
GET /item_promotion/{promotion_id}
Retrieves a specific promotion using the promotion ID. view
  Update Item Promotion
PUT /item_promotion/{promotion_id}
Updates the specified promotion details. view
PROMOTION
  Get Listings for a Specific Promotion
GET /promotion/{promotion_id}/get_listing_set
Retrieves a paged collection of the listings associated with a specific promotion. view
  Get Promotions
GET /promotion
Retrieves a list of all the seller's promotions. view
  Pause a Promotion
POST /promotion/{promotion_id}/pause
Pauses an active (RUNNING) promotion. view
  Resume a Promotion
POST /promotion/{promotion_id}/resume
Restarts a paused promotion. view
PROMOTION_REPORT
  Get a Promotion Report
GET /promotion_report
Returns a report for all the seller's promotions at a promotion level. view
PROMOTION_SUMMARY_REPORT
  Get a Promotion Summary Report
GET /promotion_summary_report
Returns the seller's promotion summary report for the specified site. view