Get Feed

Retrieve customizable product feeds for commerce applications

POST https://api.getcatalog.ai/api/feed

cURL

curl -X POST "https://api.getcatalog.ai/api/feed" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "fwrd",
    "page": 1,
    "page_size": 20
  }'

Response

{
  "products": [
    {
      "id": "sez-001",
      "title": "Silk Blouse",
      "description": "Classic silk blouse with button front",
      "vendor": "fwrd",
      "brand": "fwrd",
      "url": "https://fwrd.com/blouse-001",
      "handle": "silk-blouse",
      "is_available": true,
      "attributes": {
        "color": "cream",
        "material": "silk",
        "category": "Women > Tops",
        "season": "all-season"
      },
      "price_amount": 14999,
      "price_currency": "USD",
      "max_price": 14999,
      "min_price": 14999,
      "images": {
        "primary": "https://example.com/blouse.jpg"
      },
      "options": ["Color", "Size"],
      "variants": [
        {
          "id": "var-001",
          "color": "cream",
          "size": "M"
        }
      ],
      "store_canonical_url": "https://fwrd.com/blouse-001",
      "store_domain": "fwrd.com",
      "platform": "shopify",
      "platform_id": "123456",
      "description_html": "<p>Classic silk blouse with button front</p>",
      "product_type": "Tops",
      "tags": ["silk", "blouse", "classic"],
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "totalItems": 45,
    "totalPages": 3,
    "currentPage": 1,
    "pageSize": 20
  }
}

Get a customized product feed based on vendor and filtering criteria. Ideal for building product catalogs, recommendation engines, and commerce feeds.

Request

x-api-key · string · required

Your API key for authentication

Request Body

vendor · string · required

Filter products by specific vendor name (required)

Vendor refers to the site name of the store (e.g., ‘fwrd’, ‘amiri’, ‘ganni’). All indexed vendors can be found at the /vendor endpoint.

page · number · required

Page number for pagination (1-indexed, required)

page_size · number

Number of items to return per page (1-100, defaults to 10)

Response

products · array

Array of products matching the feed criteria

Show Product Object

id · string

Unique product identifier

title · string

Product title

description · string

Product description

vendor · string

Brand or vendor name

brand · string

Product brand

url · string

Product URL

handle · string

Product handle/slug

is_available · boolean

Product availability status

attributes · object

Rich product attributes including color, material, category, etc.

price_amount · number

Price amount

price_currency · string

Currency code

max_price · number

Maximum price for variants

min_price · number

Minimum price for variants

images · object

Product images data

options · object

Product options (size, color, etc.)

variants · object

Product variants information

store_canonical_url · string

Canonical store URL

store_domain · string

Store domain

platform · string

E-commerce platform

platform_id · string

Platform-specific ID

description_html · string

HTML-formatted description

product_type · string

Product type/category

tags · object

Product tags

updated_at · string

Last update timestamp

meta · object

Feed metadata and pagination information

Show Meta Properties

totalItems · number

Total number of products in feed

totalPages · number

Total number of pages available

currentPage · number

Current page number

pageSize · number

Number of items per page (configurable via page_size parameter, defaults to 10)

cURL

curl -X POST "https://api.getcatalog.ai/api/feed" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "fwrd",
    "page": 1,
    "page_size": 20
  }'

Response

{
  "products": [
    {
      "id": "sez-001",
      "title": "Silk Blouse",
      "description": "Classic silk blouse with button front",
      "vendor": "fwrd",
      "brand": "fwrd",
      "url": "https://fwrd.com/blouse-001",
      "handle": "silk-blouse",
      "is_available": true,
      "attributes": {
        "color": "cream",
        "material": "silk",
        "category": "Women > Tops",
        "season": "all-season"
      },
      "price_amount": 14999,
      "price_currency": "USD",
      "max_price": 14999,
      "min_price": 14999,
      "images": {
        "primary": "https://example.com/blouse.jpg"
      },
      "options": ["Color", "Size"],
      "variants": [
        {
          "id": "var-001",
          "color": "cream",
          "size": "M"
        }
      ],
      "store_canonical_url": "https://fwrd.com/blouse-001",
      "store_domain": "fwrd.com",
      "platform": "shopify",
      "platform_id": "123456",
      "description_html": "<p>Classic silk blouse with button front</p>",
      "product_type": "Tops",
      "tags": ["silk", "blouse", "classic"],
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "totalItems": 45,
    "totalPages": 3,
    "currentPage": 1,
    "pageSize": 20
  }
}

Examples

Basic Vendor Feed

Get products from a specific vendor (first page):

cURL

curl -X POST "https://api.getcatalog.ai/api/feed" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "Ganni",
    "page": 1
  }'

Paginated Results

Get the second page of products from a vendor:

cURL

curl -X POST "https://api.getcatalog.ai/api/feed" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "fwrd",
    "page": 2
  }'

Custom Page Size

Get 50 products per page from a vendor:

cURL

curl -X POST "https://api.getcatalog.ai/api/feed" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "amiri",
    "page": 1,
    "page_size": 50
  }'

Error Responses

Missing Required Parameters

{
  "error": "Invalid request: vendor parameter is required"
}