API v1
Loja

Consultar pedido da loja

GET/v1/store-orders/{orderId}charges:readNOVO

Cabeçalhos

Authorizationstringobrigatório

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

Parâmetros de caminho

orderIduuidobrigatório

Resposta 200

Pedido encontrado

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.

exemplo 4990 = R$ 49,90
coupon_codestring | nullNOVO

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

amount_centsinteger · mín. 1
exemplo 4990 = R$ 49,90
fee_centsinteger | null

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

exemplo 149 = R$ 1,49
net_amount_centsinteger | null
exemplo 4841 = R$ 48,41
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

Códigos de resposta

HTTPQuando acontece
200Pedido encontrado
400Requisição ou cursor inválido
401Chave ausente, inválida ou sem o escopo exigido
404Recurso não encontrado para o estabelecimento autenticado
429Limite de requisições excedido

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