Skip to main content
GET
Agregar compras

Autorizaciones

Authorization
string
header
requerido

Clave API creada en la configuración de la organización.

Parámetros de consulta

customer_id
string

Filtra compras por cliente.

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

Filtra por el estado financiero de la compra.

Opciones disponibles:
any,
pending,
authorized,
paid,
abandoned,
refunded,
voided
platform
enum<string>

Filtra por la plataforma de origen.

Opciones disponibles:
nuvemshop,
shopify,
woocommerce,
bling,
instagram,
popup
created_since
string<date-time>

Incluye elementos creados desde este instante, inclusive.

created_until
string<date-time>

Incluye elementos creados hasta este instante, inclusive.

min_value_in_cents
integer

Valor mínimo de la compra en centavos.

Rango requerido: x >= 0
max_value_in_cents
integer

Valor máximo de la compra en centavos.

Rango requerido: x >= 0
utm_source
string

Filtra por el utm_source del pedido.

Maximum string length: 256
utm_medium
string

Filtra por el utm_medium del pedido.

Maximum string length: 256
utm_campaign
string

Filtra por el utm_campaign del pedido.

Maximum string length: 256
utm_content
string

Filtra por el utm_content del pedido.

Maximum string length: 256
utm_term
string

Filtra por el utm_term del pedido.

Maximum string length: 256
group_by
enum<string>

Agrupa el resultado por una dimensión y devuelve su ranking.

Opciones disponibles:
status,
platform,
currency,
day,
utm_source,
utm_medium,
utm_campaign,
utm_content,
utm_term
group_limit
integer
predeterminado:10

Cantidad máxima de grupos devueltos.

Rango requerido: 1 <= x <= 50

Respuesta

Métricas agregadas de compras.

object
string
requerido
Allowed value: "purchase_stats"
purchase_count
integer
requerido
Rango requerido: x >= 0
customer_count
integer
requerido
Rango requerido: x >= 0
revenue_in_cents
integer
requerido
average_ticket_in_cents
integer
requerido
currency
string | null
requerido
Ejemplo:

"BRL"

mixed_currencies
boolean
requerido
group_by
string | null
requerido
groups
object[]
requerido
groups_truncated
boolean
requerido