Skip to main content
GET
Agregar compras

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Parâmetros de consulta

customer_id
string

Filtra compras por cliente.

Pattern: ^cus_[A-Za-z0-9_-]+$
status
enum<string>

Filtra pelo estado financeiro da compra.

Opções disponíveis:
any,
pending,
authorized,
paid,
abandoned,
refunded,
voided
platform
enum<string>

Filtra pela plataforma de origem.

Opções disponíveis:
nuvemshop,
shopify,
woocommerce,
bling,
instagram,
popup
created_since
string<date-time>

Inclui itens criados a partir deste instante, inclusive.

created_until
string<date-time>

Inclui itens criados até este instante, inclusive.

min_value_in_cents
integer

Valor mínimo da compra em centavos.

Intervalo obrigatório: x >= 0
max_value_in_cents
integer

Valor máximo da compra em centavos.

Intervalo obrigatório: x >= 0
utm_source
string

Filtra pelo utm_source do pedido.

Maximum string length: 256
utm_medium
string

Filtra pelo utm_medium do pedido.

Maximum string length: 256
utm_campaign
string

Filtra pelo utm_campaign do pedido.

Maximum string length: 256
utm_content
string

Filtra pelo utm_content do pedido.

Maximum string length: 256
utm_term
string

Filtra pelo utm_term do pedido.

Maximum string length: 256
group_by
enum<string>

Agrupa o resultado por uma dimensão e devolve o ranking dela.

Opções disponíveis:
status,
platform,
currency,
day,
utm_source,
utm_medium,
utm_campaign,
utm_content,
utm_term
group_limit
integer
padrão:10

Quantidade máxima de grupos retornados.

Intervalo obrigatório: 1 <= x <= 50

Resposta

Métricas agregadas de compras.

object
string
obrigatório
Allowed value: "purchase_stats"
purchase_count
integer
obrigatório
Intervalo obrigatório: x >= 0
customer_count
integer
obrigatório
Intervalo obrigatório: x >= 0
revenue_in_cents
integer
obrigatório
average_ticket_in_cents
integer
obrigatório
currency
string | null
obrigatório
Exemplo:

"BRL"

mixed_currencies
boolean
obrigatório
group_by
string | null
obrigatório
groups
object[]
obrigatório
groups_truncated
boolean
obrigatório