List All Products (Listings)

Retrieve collection products with pagination and filtering options

Retrieve collection products (listings) from a specific vendor with optional filtering by collection URLs. This endpoint provides paginated results with metadata for efficient browsing of large product catalogs.

Request

x-api-key · string · required

Your API key for authentication

vendor · string · required

The vendor/brand name to filter by

page · number · required

Page number for pagination (minimum: 1)

page_size · number

Number of collection products per page (minimum: 1, maximum: 100, default: 10)

collection_urls · array

Array of collection URLs

Response

listings · array

Array of listiings

Show Listing Object

id · string

Unique identifier for the collection product

url · string

Product URL

name · string

Product name/title

images · array

Array of product image objects

Show Image Object

id · string

Unique identifier for the image

url · string

Image URL

width · number

Image width in pixels

height · number

Image height in pixels

position · number

Position/order of the image in the gallery

price · object

Product pricing information

Show Price Object

currency · string

Currency code (e.g., “USD”)

current_value · number

Current price value

compare_at_value · number

Compare at price value (null if no comparison price)

vendor · string

The vendor/brand name

first_seen_by_catalog · string

ISO 8601 timestamp when the product was first added

last_updated_by_catalog · string

ISO 8601 timestamp when the product was last updated

meta · object

Pagination metadata

Show Meta Object

total_items · number

Total number of listings matching the query

total_pages · number

Total number of pages available

current_page · number

Current page number

page_size · number

Number of items per page

Error Responses

error · string

Error message describing what went wrong

details · string

Additional details about the error

cURL

curl -X POST https://api.getcatalog.ai/v1/listings \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "18east.co",
    "page": 1,
    "page_size": 10
  }'

Success Response

{
  "collection_products": [
    {
      "id": "bdc8f674-3ee7-444f-8f48-ef5f9c2bf4cf",
      "url": "https://18east.co/products/ida-bomber-moss-brown",
      "name": "IDA INSULATED BOMBER JACKET - MOSS / BROWN HERRINGBONE WOOLEN TWEED",
      "images": [
        {
          "id": "24865584-1ffe-4fd8-ba59-7866744f1d4a",
          "url": "https://cdn.shopify.com/s/files/1/0026/8707/4416/files/2024_18E_WINTER_068_ab9b99a1-60f9-4f0c-b5ec-4cdefdee364f.jpg?v=1731645869",
          "width": 2880,
          "height": 3600,
          "position": 1
        },
        {
          "id": "a9afe970-8727-4839-ba82-f4ad07d074ab",
          "url": "https://cdn.shopify.com/s/files/1/0026/8707/4416/files/2024_18E_WINTER_072_fa695e3d-d0bb-4aff-a77a-750029a46e8c.jpg?v=1731645869",
          "width": 2880,
          "height": 3600,
          "position": 2
        }
      ],
      "price": {
        "currency": "USD",
        "current_value": 478,
        "compare_at_value": null
      },
      "vendor": "18east.co",
      "first_seen_by_catalog": "2025-09-02T07:27:26.545676+00:00",
      "last_updated_by_catalog": "2025-09-02T07:31:35.43881+00:00"
    }
  ],
  "meta": {
    "total_items": 333,
    "total_pages": 34,
    "current_page": 1,
    "page_size": 10
  }
}