API docs by Redocly

Buy Marketing API (v1_beta.2.0)

Download OpenAPI specification:Download

License: eBay API License Agreement

The Marketing API retrieves eBay products based on a metric, such as Best Selling, as well as products that were also bought and also viewed.

merchandised_product

getMerchandisedProducts

This method returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product ID (EPID), title, and user reviews and ratings for the product. You can use the epid returned by this method in the Browse API search method to retrieve items for this product.

Restrictions

  • To test getMerchandisedProducts in Sandbox, you must use category ID 9355 and the response will be mock data.
  • For a list of supported sites and other restrictions, see API Restrictions.

Authorizations:
Client_Credentials
query Parameters
aspect_filter
string

The aspect name/value pairs used to further refine product results.

For example:
   /buy/marketing/v1_beta/merchandised_product?category_id=31388&metric_name=BEST_SELLING&aspect_filter=Brand:Canon

You can use the Browse API search method with the fieldgroups=ASPECT_REFINEMENTS field to return the aspects of a product. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/marketing/types/gct:MarketingAspectFilter

category_id
required
string

This query parameter limits the products returned to a specific eBay category.

The list of eBay category IDs is not published and category IDs are not all the same across all the eBay maketplace. You can use the following techniques to find a category by site:

  • Use the Category Changes page.
  • Use the Taxonomy API. For details see Get Categories for Buy APIs.
  • Use the Browse API and submit the following method to get the dominantCategoryId for an item.
    /buy/browse/v1/item_summary/search?q=keyword&fieldgroups=ASPECT_REFINEMENTS
Maximum: 1
Required: 1

limit
string

This value specifies the maximum number of products to return in a result set.

Note: Maximum value means the method will return up to that many products per set, but it can be less than this value. If the number of products found is less than this value, the method will return all of the products matching the criteria.

Default: 8
Maximum: 100

metric_name
required
string

This value filters the result set by the specified metric. Only products in this metric are returned. Currently, the only metric supported is BEST_SELLING.

Default: BEST_SELLING
Maximum: 1
Required: 1

Responses