MerchantHQ API
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}/sales-ranks
Default

Get the current sales ranks for an Amazon marketplace catalog item.

Path parameters

  • marketplace_catalog_item string(uuid) Required

    The UUID of the marketplace catalog item

Responses

  • 200 application/json

    A successful response returning the list of sales ranks

    Hide response attribute Show response attribute object
    • ranks array[object] Required

      Representation of an Amazon sales rank for a catalog item

      Hide ranks attributes Show ranks attributes object
      • rank integer Required

        The sales rank number

        Minimum value is 1.

      • title string Required

        The display title for this sales rank category

      • link string(uri) Required

        The URL link to the sales rank information
  • 401 application/json

    The request requires user authentication or the user is not authorized to access this resource.

    Hide response attribute Show response attribute object
    • message string
  • 404 application/json

    The specified resource was not found

    Hide response attribute Show response attribute object
    • message string
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}/sales-ranks 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/marketplaces/catalog-items/1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4/sales-ranks' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "ranks": [
    {
      "rank": 123,
      "title": "Electronics",
      "link": "https://www.amazon.com/gp/bestsellers/electronics"
    }
  ]
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (404) 
{
  "message": "Not found"
}