Products
Products with embedded variants.
20 fields — 14 dimensions, 6 metrics. Date clauses (SINCE, UNTIL, DURING) use createdAt.
The live, authoritative list is always GET /v1/datasets — this page is regenerated from the same catalog, but the endpoint reflects exactly what is deployed.
Query it
FROM products
SHOW product_count
GROUP BY title
SINCE -30d
See Querying with SoloQL for the language.
Fetch records
curl -H "Authorization: Bearer esk_live_..." \
"https://api.ecomsolo.com/v1/products?page_size=50&fields=title,handle,vendor"
Any field marked ✅ below can be returned, requested via fields=, and used as an equality filter (?field=value). Fields marked aggregate only exist for COUNT-style questions and have no value on a single record — ask SoloQL for those. See Fetching records.
Fields
| Field | Type | Role | Records | Description |
|---|---|---|---|---|
title | string | dimension | ✅ | Product title. |
handle | string | dimension | ✅ | Product URL handle. |
vendor | string | dimension | ✅ | Product vendor. |
product_type | string | dimension | ✅ | Product type. |
status | string | dimension | ✅ | Product status (active, draft, archived). |
tags | string | dimension | ✅ | Comma-separated product tags. |
is_gift_card | boolean | dimension | ✅ | Whether the product is a gift card. |
is_published | boolean | dimension | ✅ | Whether the product is published. |
published_at | date | dimension | ✅ | When the product was published. |
created_at | date | dimension | ✅ | When the product was created. |
product_count | number | metric | aggregate only | Number of products in the group (document count — value_count on createdAt). Sums across stores. |
total_inventory | number | metric | ✅ | Total inventory across all variants and locations. |
variant_sku | string | dimension | ✅ | SKU of a product variant. |
variant_title | string | dimension | ✅ | Title of a product variant. |
variant_barcode | string | dimension | ✅ | Barcode of a product variant. |
variant_price | money | metric | ✅ | Price of a product variant. |
variant_compare_at_price | money | metric | ✅ | Compare-at price of a product variant. |
variant_cost | money | metric | ✅ | Cost per item of a product variant. |
variant_inventory_quantity | number | metric | ✅ | Inventory quantity of a product variant. |
store | string | dimension | ✅ | The shop the record belongs to. Filter with WHERE store IN ('Shop name') or GROUP BY store. |