E-commerce Summary

Resumo de pedidos VTEX

GET
/v1/vtex/orders/summary

Totais agregados de pedidos da VTEX no período informado. status filtra diretamente a coluna status da VTEX (ex.: invoiced, canceled). Dimensões de groupBy: payment_method, utm_source, utm_campaign (colunas do pedido) e product (faz join com vtex_order_items; totalRevenue = selling_price × quantity, totalOrders = pedidos distintos que contêm o produto; a linha (outros) informa apenas key e totalRevenue — seus totalOrders, avgTicket e uniqueCustomers são null). Uma dimensão não suportada retorna 400 listando as válidas. Os clientes são resolvidos pelo registro de cliente do pedido (user_profile_id): totalCustomers conta pedidos com cliente identificado e uniqueCustomers os compradores distintos.

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

dateStart*string

Início do período (YYYY-MM-DD), filtra creation_date

Formatodate
dateEnd*string

Fim do período (YYYY-MM-DD), filtra creation_date (dia inteiro incluído)

Formatodate
integrationName?string

Restringe a uma única integração de loja

status?string

Status do pedido na VTEX (ex.: invoiced, canceled). Quando omitido, pedidos cancelados/com cancelamento solicitado e pedidos sem authorized_date são excluídos por padrão; informá-lo substitui esse padrão.

groupBy?string

Detalha o resumo por uma dimensão. A VTEX suporta: payment_method, utm_source, utm_campaign, product.

Valor em"payment_method""utm_source""utm_campaign""product"
gtmMotionId?string

GTM 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.

Formatouuid
paymentStatus?"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.

Valor em"paid"

Corpo da resposta

Resumo de pedidos (com eco de groupBy e groups quando solicitado)

application/json
  1. response
totalOrders?integer
totalRevenue?number
Formatofloat
avgTicket?number
Formatofloat
totalCustomers?integer
uniqueCustomers?integer
period?
platform?string
Valor em"vtex""shopify""tray"
integrationName?string|null
groupBy?string

Eco da dimensão solicitada. Presente apenas quando groupBy foi enviado.

Valor em"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.

Valor em"paid"
curl -X GET "https://example.com/v1/vtex/orders/summary?organizationId=org_123&dateStart=2019-08-24&dateEnd=2019-08-24&gtmMotionId=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"}