Visão geral

A API de Resumo de E-commerce retorna totais agregados de pedidos de uma loja em uma única chamada — sem paginação. As métricas são calculadas a partir dos pedidos no momento da consulta, então refletem os dados mais recentes e aceitam qualquer recorte de período.

Endpoints disponíveisCopiar link da seção

• getResumo de pedidos VTEX/v1/vtex/orders/summaryTotais agregados de pedidos da VTEX no período informado.
• getResumo de pedidos Shopify/v1/shopify/orders/summaryTotais agregados de pedidos do Shopify no período informado.
• getResumo de pedidos Tray/v1/tray/orders/summaryTotais agregados de pedidos da Tray no período informado.

RespostaCopiar link da seção

Cada endpoint retorna:

• totalOrders – número de pedidos no período
• totalRevenue – soma do valor dos pedidos
• avgTicket – totalRevenue / totalOrders (0 quando não há pedidos)
• totalCustomers – pedidos com cliente identificável
• uniqueCustomers – clientes distintos
• period, platform, integrationName
• groupBy / groups – presentes apenas quando groupBy foi enviado: top-20 grupos por receita, cada um com key, totalOrders, totalRevenue, avgTicket, uniqueCustomers. Quando há restante, uma linha (outros) aparece com os mesmos campos; valores nulos/vazios da dimensão caem no balde (sem valor). O grupo (sem valor), quando tem registros, é sempre retornado como um grupo explícito próprio — mesmo fora do top-20 — e seus números são excluídos do (outros). Para groupBy=product, a linha (outros) traz apenas key e totalRevenue — totalOrders, avgTicket e uniqueCustomers vêm null (um pedido pode conter vários produtos, então essas contagens não são deriváveis para o restante); o próprio grupo (sem valor) continua com métricas completas.

Parâmetros comunsCopiar link da seção

• organizationId (obrigatório)
• dateStart / dateEnd (obrigatórios, YYYY-MM-DD)
• integrationName – restringe a uma única loja
• status – filtro por status do pedido
• groupBy – dimensão opcional de quebra. VTEX: payment_method, utm_source, utm_campaign, product; Shopify: utm_source, utm_campaign, product, source_name; Tray: payment_method, product. Uma dimensão não suportada retorna 400 listando as válidas da plataforma.

Filtro de statusCopiar link da seção

As três plataformas (VTEX, Shopify, Tray) filtram a coluna status nativa diretamente — passe o valor de status da própria plataforma (ex: VTEX invoiced).

AutenticaçãoCopiar link da seção

Todos os endpoints exigem autenticação via os headers padrão da API V4MOS.AI.