API v1
Loja

Listar pedidos da loja

GET/v1/store-orderscharges:readNOVO

Pedidos das suas lojas (vitrine e links de pagamento), mais novos primeiro. Um pedido existe quando o comprador inicia o Pix; carrinhos abandonados não aparecem. Situação do pagamento em status, da entrega em delivery_status.

Cabeçalhos

Authorizationstringobrigatório

Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.

Parâmetros de consulta

limitinteger · 1–100opcional
cursorstring · 1–512opcional

Cursor opaco devolvido pela página anterior.

store_iduuidopcional

Só os pedidos desta loja.

Resposta 200

Página, mais novos primeiro

dataobject[]
18 campos
iduuid

Identificador do pedido (o mesmo da sessão de checkout).

object"store_order"
storeobject
3 campos
iduuid
namestring
slugstring
statusstring

Situação do Pix do pedido.

CREATINGPENDINGPAIDFAILEDCANCELEDEXPIREDUNDER_REVIEWREVERSED
delivery_statusstring

AWAITING_PAYMENT: Pix não confirmado. PREPARING: pago, entrega automática em andamento. AWAITING_MERCHANT: a loja entrega por conta própria (serviço). REVIEW: a entrega automática não pôde ser concluída e a loja confere. DELIVERED: entregue (automática ou marcada pela loja).

AWAITING_PAYMENTPREPARINGAWAITING_MERCHANTREVIEWDELIVERED
itemsobject[]
5 campos
product_iduuid | null
variant_iduuid | null
namestring

Produto e opção no momento da compra.

unit_amount_centsinteger · mín. 1
quantityinteger · mín. 1
discount_centsintegerNOVO

Desconto de cupom da loja congelado na criação (lote 3B-9C2). amount_cents já é o total depois dele; os itens mantêm o preço cheio. 0 sem cupom.

coupon_codestring | nullNOVO

Código do cupom aplicado (maiúsculas), ou null.

amount_centsinteger · mín. 1
fee_centsinteger | null

Tarifa da loja; null antes de existir cobrança com tarifa.

net_amount_centsinteger | null
currency"BRL"
customer_emailstring

Contato informado pelo comprador; não é identidade verificada.

charge_iduuid
metadataobject

Inclui store_slug e, em compras por link, payment_link.

created_atdatetime
paid_atdatetime | null
delivered_atdatetime | null
next_cursorstring | null

Códigos de resposta

HTTPQuando acontece
200Página, mais novos primeiro
400Requisição ou cursor inválido
401Chave ausente, inválida ou sem o escopo exigido
429Limite de requisições excedido

Cada código de erro está explicado em Erros.