Orders

Orders with financial, fulfillment and line-item data.

32 fields — 20 dimensions, 12 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 orders
  SHOW order_count
  GROUP BY order_name
  SINCE -30d

See Querying with SoloQL for the language.

Fetch records

curl -H "Authorization: Bearer esk_live_..." \
  "https://api.ecomsolo.com/v1/orders?page_size=50&fields=order_name,order_number,email"

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
order_namestringdimensionOrder name, e.g. #1001.
order_numbernumberdimensionSequential order number.
emailstringdimensionCustomer email on the order.
customer_namestringdimensionCustomer display name.
financial_statusstringdimensionPayment status (paid, pending, refunded, etc.).
fulfillment_statusstringdimensionFulfillment status (fulfilled, partial, unfulfilled, etc.).
order_statusstringdimensionOpen, archived or cancelled.
currencystringdimensionOrder currency code.
sales_channelstringdimensionChannel the order was placed on.
source_namestringdimensionOrder source (web, pos, draft_order, etc.).
gatewaystringdimensionPayment gateway.
location_namestringdimensionLocation attributed to the order.
tagsstringdimensionComma-separated order tags.
is_testbooleandimensionWhether this is a test order.
created_atdatedimensionWhen the order was created.
processed_atdatedimensionWhen the order was processed.
cancelled_atdatedimensionWhen the order was cancelled.
order_countnumbermetricaggregate onlyNumber of orders in the group (document count — value_count on createdAt). Sums across stores.
total_pricemoneymetricTotal order price including taxes, shipping and discounts.
subtotal_pricemoneymetricLine items price after discounts, before shipping and taxes.
total_taxmoneymetricTotal tax charged.
total_discountsmoneymetricTotal discount amount applied.
total_tipmoneymetricTotal tips received.
net_paymentmoneymetricPayments received minus refunds.
total_outstandingmoneymetricAmount still owed on the order.
items_countnumbermetricNumber of items in the order.
total_weightnumbermetricTotal order weight in grams.
line_item_skustringdimensionSKU of an ordered line item.
line_item_titlestringdimensionTitle of an ordered line item.
line_item_quantitynumbermetricUnits ordered of a line item.
line_item_pricemoneymetricUnit price of a line item.
storestringdimensionThe shop the record belongs to. Filter with WHERE store IN ('Shop name') or GROUP BY store.