Own Recommendation? Customize your docs with AI search, analytics, and more.

GET

/merchandised_product

https://api.ebay.com/buy/marketing/v1_beta/merchandised_product

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 <code>epid</code> returned by this method in the Browse API search method to retrieve items for this product. <h3>Restrictions </h3> <ul><li>To test getMerchandisedProducts in Sandbox, you must use category ID 9355 and the response will be mock data. </li> <li>For a list of supported sites and other restrictions, see <a href="/api-docs/buy/marketing/overview.html#API">API Restrictions</a>.</li> </ul>

Access Token Required: API Key

Query Params

aspect_filterstring

The aspect name/value pairs used to further refine product results. For example:    <code>/buy/marketing/v1_beta/merchandised_product?category_id=31388&metric_name=BEST_SELLING&aspect_filter=Brand:Canon</code> You can use the Browse API search method with the <code>fieldgroups=ASPECT_REFINEMENTS</code> 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_idstringrequired

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: <ul> <li>Use the <a href="https://pages.ebay.com/sellerinformation/news/categorychanges.html" target="_blank">Category Changes page</a>.</li> <li>Use the Taxonomy API. For details see <a href="/api-docs/buy/buy-categories.html">Get Categories for Buy APIs</a>. </li> <li>Use the Browse API and submit the following method to get the dominantCategoryId for an item. <code>/buy/browse/v1/item_summary/search?q=keyword&fieldgroups=ASPECT_REFINEMENTS </code></li></ul> Maximum: 1 Required: 1

limitstring

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_namestringrequired

This value filters the result set by the specified metric. Only products in this metric are returned. Currently, the only metric supported is <code> BEST_SELLING</code>. Default: BEST_SELLING Maximum: 1 Required: 1

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.ebay.com/buy/marketing/v1_beta/merchandised_product' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/merchandised_product

https://api.ebay.com/buy/marketing/v1_beta/merchandised_product

Access Token Required: API Key

Query Params

aspect_filterstring

category_idstringrequired

limitstring

metric_namestringrequired

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.ebay.com/buy/marketing/v1_beta/merchandised_product' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/merchandised_product

https://api.ebay.com/buy/marketing/v1_beta/merchandised_product

Access Token Required: API Key

Query Params

aspect_filterstring

category_idstringrequired

limitstring

metric_namestringrequired

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.ebay.com/buy/marketing/v1_beta/merchandised_product' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/merchandised_product

https://api.ebay.com/buy/marketing/v1_beta/merchandised_product

Access Token Required: API Key

Query Params

aspect_filterstring

category_idstringrequired

limitstring

metric_namestringrequired

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.ebay.com/buy/marketing/v1_beta/merchandised_product' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}