Overview

The E-commerce Summary API returns aggregated order totals for a store in a single call — no pagination. Metrics are computed from the orders at query time, so they reflect the latest data and accept any date range.

Available EndpointsCopy Anchor Link

• getVTEX orders summary/v1/vtex/orders/summaryAggregated totals for VTEX orders over the given period.
• getShopify orders summary/v1/shopify/orders/summaryAggregated totals for Shopify orders over the given period.
• getTray orders summary/v1/tray/orders/summaryAggregated totals for Tray orders over the given period.

ResponseCopy Anchor Link

Each endpoint returns:

• totalOrders – number of orders in the period
• totalRevenue – summed order value
• avgTicket – totalRevenue / totalOrders (0 when there are no orders)
• totalCustomers – orders with an identifiable customer
• uniqueCustomers – distinct customers
• period, platform, integrationName
• groupBy / groups – present only when groupBy was sent: top-20 groups by revenue, each with key, totalOrders, totalRevenue, avgTicket, uniqueCustomers. When a remainder exists, an (outros) remainder row appears with the same fields; 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). For groupBy=product, the (outros) row carries only key and totalRevenue — totalOrders, avgTicket and uniqueCustomers are null (an order can span several products, so those counts cannot be derived for the remainder); the (sem valor) group itself still carries full metrics.

Common ParametersCopy Anchor Link

• organizationId (required)
• dateStart / dateEnd (required, YYYY-MM-DD)
• integrationName – restrict to a single store
• status – order status filter
• groupBy – optional breakdown dimension. VTEX: payment_method, utm_source, utm_campaign, product; Shopify: utm_source, utm_campaign, product, source_name; Tray: payment_method, product. An unsupported dimension returns 400 listing the platform's valid ones.

Status filteringCopy Anchor Link

All three platforms (VTEX, Shopify, Tray) filter their native status column directly — pass the platform's own status value (e.g. VTEX invoiced).

AuthenticationCopy Anchor Link

All endpoints require authentication via the standard V4MOS.AI API headers.