Skip to main content
GET
Listar compras do cliente

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

customer_id
string
obrigatório

ID público do cliente.

Pattern: ^cus_[A-Za-z0-9_-]+$

Parâmetros de consulta

limit
integer
padrão:25

Quantidade máxima de itens por página.

Intervalo obrigatório: 1 <= x <= 100
starting_after
string

ID da última compra da página anterior.

Pattern: ^pur_[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

Resposta

Página de compras.

has_more
boolean
obrigatório

Indica se existe uma próxima página.

data
object[]
obrigatório