List of marketplace catalog items

GET /2024-09/marketplaces/catalog-items

Default

Get the list of catalog items for marketplaces with optional filters.

Query parameters

marketplace_id string(uuid)

Filter catalog items by marketplace UUID
marketplace_identifier string

Filter by marketplace-specific identifier (e.g., ASIN)
upc string

Filter by Universal Product Code
ean string

Filter by European Article Number
gtin string

Filter by Global Trade Item Number
isbn string

Filter by International Standard Book Number
page integer

The page number to retrieve

Minimum value is 1.
per_page integer

The number of results to return per page

Minimum value is 1, maximum value is 100.

Responses

200 application/json

A successful response returning the list of marketplace catalog items
Hide response attributes Show response attributes object
- links object
  
  Hide links attributes Show links attributes object
  
  first string
  
  last string
  
  prev string | null
  
  next string | null
- meta object
  
  Hide meta attributes Show meta attributes object
  
  current_page integer
  
  from integer | null
  
  last_page integer
  
  path string
  
  per_page integer
  
  to integer | null
  
  total integer
- data array[object] Required
  
  Representation of a catalog item in a marketplace
  
  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

GET /2024-09/marketplaces/catalog-items

curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/marketplaces/catalog-items' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "links": {
    "first": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "last": "https://app.merchanthq.com/api/2024-09/merchants?page=10",
    "prev": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "next": "https://app.merchanthq.com/api/2024-09/merchants?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://app.merchanthq.com/api/2024-09/merchants",
    "per_page": 10,
    "to": 10,
    "total": 20
  },
  "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"
}