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

Get a single marketplace catalog item by its ID.

Path parameters

  • marketplace_catalog_item string(uuid) Required

    The UUID of the marketplace catalog item

Responses

  • 200 application/json

    A successful response returning the marketplace catalog item

    Hide response attribute Show response attribute object
    • data object Required

      Representation of a catalog item in a marketplace

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string(uuid)

        The UUID of the resource.

      • marketplace_id string(uuid)

        The UUID of the marketplace this catalog item belongs to

      • title string

        The title of the catalog item

      • marketplace_identifier string

        The marketplace-specific identifier (e.g., ASIN on Amazon)

      • identifiers array[object]

        Array of catalog item identifiers

        Hide identifiers attributes Show identifiers attributes object
        • id string(uuid)

          The UUID of the resource.

        • marketplace_catalog_item_id string(uuid)

          The UUID of the marketplace catalog item this identifier belongs to

        • type string

          The type of identifier

          Values are UPC, EAN, GTIN, or ISBN.

        • value string

          The identifier value

        • created_at string(date-time)

          The date and time the resource was created.

        • updated_at string(date-time)

          The date and time the resource was last updated.

      • main_image_id string | null

        The UUID of the main catalog item image

      • main_image_url string | null

        The URL of the main catalog item image

      • thumbnail_image_id string | null

        The UUID of the thumbnail catalog item image

      • thumbnail_image_url string | null

        The URL of the thumbnail catalog item image

      • created_at string(date-time)

        The date and time the resource was created.

      • updated_at string(date-time)

        The date and time the resource was last updated.
  • 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} 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/marketplaces/catalog-items/1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "marketplace_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "title": "Wireless Bluetooth Headphones",
    "marketplace_identifier": "B08N1W7D4R",
    "identifiers": [
      {
        "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
        "marketplace_catalog_item_id": "string",
        "type": "UPC",
        "value": "string",
        "created_at": "2025-01-10T10:37:11Z",
        "updated_at": "2025-01-10T10:37:11Z"
      }
    ],
    "main_image_id": "2e8f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d5",
    "main_image_url": "https://example.com/images/2e8f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d5.jpg",
    "thumbnail_image_id": "3e9f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d6",
    "thumbnail_image_url": "https://example.com/images/3e9f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d6.jpg",
    "created_at": "2025-01-10T10:37:11Z",
    "updated_at": "2025-01-10T10:37:11Z"
  }
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (404) 
{
  "message": "Not found"
}