Skip to main content
GET
Listar pedidos
Requer o escopo orders:read. Pagine com page e per_page (padrão 15). O filtro é type, com três valores: main (a venda principal), upsell (o pedido de uma oferta do funil) e subscription_renewal (a cobrança de renovação).
Não há filtro por status: filtre no seu lado, pelo campo status de cada pedido. Um valor de type desconhecido devolve a página vazia, em vez de ser ignorado.
Cada pedido traz product_sku, o sku do produto vendido, e tracking, a atribuição do comprador. Os valores vêm em settlement_total e settlement_seller, strings decimais na moeda de settlement_currency. Veja a receita Listar e filtrar pedidos.

Authorizations

Authorization
string
header
required

A chave de API da conta, no formato sk_{modo}_{prefixo}.{segredo}.

Query Parameters

type
enum<string>

Filtra pelo tipo do pedido.

Available options:
main,
upsell,
subscription_renewal
per_page
integer
default:15
page
integer
default:1

Response

Paginated set of ApiOrderResource

data
ApiOrderResource · object[]
required
meta
object
required