MerchantHQ API
GET /2024-09/channels/{channel}/catalog-search
Default

Search for catalog items in a channel's marketplace

Path parameters

  • channel string(uuid) Required

    The UUID of the channel

Query parameters

  • title string

    Search by title/keywords

  • marketplace_identifier string

    Search by marketplace identifier (e.g., ASIN)

  • upc string

    Search by UPC

  • ean string

    Search by EAN

  • gtin string

    Search by GTIN

  • isbn string

    Search by ISBN

Responses

  • 200 application/json

    A successful response returning the catalog items

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

      Representation of a catalog item from a channel search

      Hide data attributes Show data attributes object
      • title string Required

        The title of the catalog item

      • marketplace_identifier string Required

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

      • images array[string(uri)] Required

        Array of image URLs for the catalog item

      • identifiers array[object] Required

        Array of product identifiers

        Hide identifiers attributes Show identifiers attributes object
        • type string Required

          The type of identifier

          Values are UPC, EAN, GTIN, or ISBN.

        • value string Required

          The identifier value
  • 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
  • 403 application/json

    Forbidden - The user does not have permission to access this resource.

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

    The specified resource was not found

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

    The request was unprocessable due to validation errors

    Hide response attributes Show response attributes object
    • message string Required
    • errors object Required

      A map of field names to arrays of error messages

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
GET /2024-09/channels/{channel}/catalog-search 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/channels/1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4/catalog-search' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "title": "Wireless Bluetooth Headphones",
      "marketplace_identifier": "B08N1W7D4R",
      "images": [
        "https://example.com/image1.jpg"
      ],
      "identifiers": [
        {
          "type": "UPC",
          "value": "012345678905"
        }
      ]
    }
  ]
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (403) 
{
  "message": "This action is unauthorized."
}
Response examples (404) 
{
  "message": "Not found"
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field_name": [
      "The field name field is required."
    ]
  }
}