Skip to main content
BETA. The catalog stream is the foundational stream — every other stream references products from here.
The catalog stream projects the product record per product from ProductV2: title, slug, type, status, visibility, purchasability, tags, and Google product category. Rows are scoped to the shops owned by the API key’s merchant.

Endpoint

Query parameters:
There is no shop_id query parameter — rows are already scoped to the key’s merchant (across all shops the merchant owns). Tenant isolation is enforced server-side regardless of query.

Row shape

Response envelope

curl

Snapshot

For a cached point-in-time view of the first 200 rows (TTL controlled by INVENTORY_OS_API_SNAPSHOT_CACHE_TTL_SEC, default 300s):

Cursor pagination

Pages return nextCursor until the stream is exhausted (null). Cursors are opaque — don’t parse them. Use since for incremental syncs instead of walking the full feed each time.

Rate limits

Catalog reads are in the high-budget class — 1000 reads/min/key. Use since + a larger limit for incremental syncs; full crawls should be hourly or less frequent.