VTEX orders summary
Aggregated totals for VTEX orders over the given period. status filters the VTEX status column directly (e.g. invoiced, canceled). groupBy dimensions: payment_method, utm_source, utm_campaign (order columns) and product (joins vtex_order_items; totalRevenue = selling_price × quantity, totalOrders = distinct orders containing the product; the (outros) row reports only key and totalRevenue — its totalOrders, avgTicket and uniqueCustomers are null). An unsupported dimension returns 400 listing the valid ones. Customers are resolved through the order's customer record (user_profile_id): totalCustomers counts orders with an identified customer and uniqueCustomers the distinct buyers.
ClientIdAuthClientSecretAuthx-client-id<token>Client ID
x-client-secret<token>Client secret
organizationId*stringOrganization identifier (required)
dateStart*stringPeriod start (YYYY-MM-DD), filters creation_date
datedateEnd*stringPeriod end (YYYY-MM-DD), filters creation_date (whole day included)
dateintegrationName?stringRestrict to a single store integration
status?stringVTEX order status (e.g. invoiced, canceled). When omitted, canceled/cancellation-requested orders and orders without authorized_date are excluded by default; passing it replaces that default.
groupBy?stringBreak the summary down by one dimension. VTEX supports: payment_method, utm_source, utm_campaign, product.
"payment_method""utm_source""utm_campaign""product"gtmMotionId?stringGTM motion of the organization (UUID), as listed by GET /v1/gtm-motions. Optional: without it, the response covers the organization's default GTM motion. The default motion is answered with the organization's data, the same numbers as when the parameter is omitted. Any other GTM motion of the organization (V4MOS-2707) is answered with the orders of its stores only: the stores with an order in analytics.fct_transactions_by_gtm_motion for the motion, by the key the order facts give a store (vtex_orders.document_id, shopify_orders.store_key, tray_orders.store_key); a motion without a store answers zero orders. Not a UUID: 400. Not a live GTM motion of the organization: 403 GTM_MOTION_NOT_IN_ORGANIZATION.
uuidpaymentStatus?"paid"Narrow the summary to paid orders: authorized_date set (the payment approval, same predicate as the official revenue in int_unified_transactions). This is already part of the default; it matters when an explicit status replaces the default. Echoed back as paymentStatus. Omitted, the summary is unchanged.
"paid"Orders summary (with groupBy echo and groups when requested)
application/json- response
totalOrders?integertotalRevenue?numberfloatavgTicket?numberfloattotalCustomers?integeruniqueCustomers?integerperiod?platform?string"vtex""shopify""tray"integrationName?string|nullgroupBy?stringEcho of the requested dimension. Present only when groupBy was sent.
"payment_method""utm_source""utm_campaign""product""source_name""main_product"groups?array<>Present only when groupBy was sent. Top-20 groups ordered by totalRevenue desc, plus an '(outros)' row aggregating the remainder when one exists. Null/blank dimension values are bucketed as '(sem valor)'. The '(sem valor)' group, when it has rows, is always returned as its own explicit group — even outside the top-20 — and its numbers are excluded from '(outros)'. On order-grain dimensions (payment_method, utm_source, utm_campaign, source_name, main_product) the '(outros)' row is complete — its uniqueCustomers is a clamped lower-bound approximation (distinct counts do not subtract across groups). For groupBy=product (item grain) the '(outros)' row carries ONLY key and totalRevenue: totalOrders, avgTicket and uniqueCustomers are null, because per-product order counts overlap (one order counts once per product it contains) and the remainder's counts cannot be derived; the '(sem valor)' group at item grain is a normal group with full metrics.
paymentStatus?"paid"Echo of the requested payment state. Present only when paymentStatus was sent: without it the totals count every order the validity default (or the explicit status) lets through, paid or not.
"paid"curl -X GET "https://example.com/v1/vtex/orders/summary?organizationId=org_123&dateStart=2019-08-24&dateEnd=2019-08-24>mMotionId=019a5b2e-7c4d-7abc-8def-0123456789ab"{ "totalOrders": 847, "totalRevenue": 152340.5, "avgTicket": 179.86, "totalCustomers": 612, "uniqueCustomers": 489, "period": { "start": "2026-06-01", "end": "2026-06-23" }, "platform": "vtex", "integrationName": "lupo-vtex", "groupBy": "payment_method", "groups": [ { "key": "creditCard", "totalOrders": 412, "totalRevenue": 80231.4, "avgTicket": 194.74, "uniqueCustomers": 322 } ], "paymentStatus": "paid"}