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

FieldTypeRoleRecordsDescription
titlestringdimensionProduct title.
handlestringdimensionProduct URL handle.
vendorstringdimensionProduct vendor.
product_typestringdimensionProduct type.
statusstringdimensionProduct status (active, draft, archived).
tagsstringdimensionComma-separated product tags.
is_gift_cardbooleandimensionWhether the product is a gift card.
is_publishedbooleandimensionWhether the product is published.
published_atdatedimensionWhen the product was published.
created_atdatedimensionWhen the product was created.
product_countnumbermetricaggregate onlyNumber of products in the group (document count — value_count on createdAt). Sums across stores.
total_inventorynumbermetricTotal inventory across all variants and locations.
variant_skustringdimensionSKU of a product variant.
variant_titlestringdimensionTitle of a product variant.
variant_barcodestringdimensionBarcode of a product variant.
variant_pricemoneymetricPrice of a product variant.
variant_compare_at_pricemoneymetricCompare-at price of a product variant.
variant_costmoneymetricCost per item of a product variant.
variant_inventory_quantitynumbermetricInventory quantity of a product variant.
storestringdimensionThe shop the record belongs to. Filter with WHERE store IN ('Shop name') or GROUP BY store.