Pular para o conteúdo principal
Buscar pedido
Devolve um objeto pedido pelo id (ord_...), quando a conta é dona do pedido ou participa dele por coprodução.
  • Mesmo 404 para pedido de outra conta. Um pedido que não existe e um pedido de outra conta recebem a mesma resposta 404 resource_missing. A API não revela se um id existe fora da sua conta.
  • Mesmo formato da lista. O pedido devolvido aqui é igual ao que aparece em data de Listar pedidos: os mesmos campos, com as mesmas regras de coprodução.

Autorizações

Authorization
string
header
obrigatório

Chave de API da conta (zt_live_...), criada em Configurações → Chaves de API no dashboard.

Parâmetros de caminho

id
string
obrigatório

Identificador do pedido (ord_...).

Resposta

O pedido.

Pedido da conta. O formato é fixo: campo sem valor vem null, nunca ausente. Valores monetários em centavos (inteiros).

object
enum<string>
obrigatório

Tipo do objeto: sempre order.

Opções disponíveis:
order
id
string
obrigatório

Identificador do pedido (ord_...).

role
enum<string>
obrigatório

OWNER quando a conta é dona do pedido; COPRODUCER quando participa por coprodução. O coprodutor vê os valores do pedido inteiro, não a parte dele; só tracking e navigator vêm null.

Opções disponíveis:
OWNER,
COPRODUCER
status
enum<string>
obrigatório

Situação do pedido:

  • AWAITING_PAYMENT: PIX ou boleto emitido e ainda pagável; também o pagamento dividido entre a primeira e a segunda parte, e o primeiro status do parcelado inteligente.
  • UNPAID: cobrança tentada sem pagamento — cartão recusado (inclusive pelo antifraude), PIX ou boleto expirado, período de teste de assinatura expirado sem conversão, assinatura cancelada no prazo de inadimplência.
  • PAID: todo pagamento cobrado está pago (no pagamento dividido, todas as partes). Estorno parcial mantém PAID.
  • CANCELED: pagamento dividido não concluído em 20 minutos; as partes pagas são estornadas.
  • SHIPPED, DELIVERED: reservados; não são usados hoje.
  • REFUNDED: todo pagamento cobrado foi estornado por inteiro.
  • DISPUTED: chargeback em todo pagamento cobrado; disputa ganha volta a PAID.
  • TRIAL: assinatura em período de teste, cartão guardado sem cobrança; valores 0.

A renovação de assinatura não muda o status do pedido: o pagamento novo entra no mesmo pedido e aparece em payment. Um pedido pode mudar de status mais de uma vez; aceite qualquer transição.

Opções disponíveis:
AWAITING_PAYMENT,
UNPAID,
PAID,
CANCELED,
SHIPPED,
DELIVERED,
REFUNDED,
DISPUTED,
TRIAL
currency
string | null
obrigatório

Moeda do pedido (ISO 4217, ex. BRL).

amount_total
integer
obrigatório

Valor cobrado no checkout, em centavos (parcelado inteligente, o valor total do contrato).

amount_subtotal
integer | null
obrigatório

Soma de preço × quantidade dos produtos, em centavos.

amount_in_brl
integer | null
obrigatório

Valor total em BRL, em centavos. Hoje igual a amount_total nos pedidos de infoproduto.

created_at
string<date-time>
obrigatório

Instante de criação do pedido.

paid_at
string<date-time> | null
obrigatório

Instante em que o pedido foi pago; null quando não há.

canceled_at
string<date-time> | null
obrigatório

Instante do cancelamento; null quando não há.

updated_at
string<date-time> | null
obrigatório

Instante (UTC, com milissegundos) em que algum campo deste objeto mudou pela última vez: status, valores, pagamento, estorno, cliente, endereço, itens, oferta, cupom, UTM ou metadata. Reprocessamento interno que não muda nada do que a API devolve não avança este campo. null em pedido que ainda não passou pelo preenchimento inicial.

customer
object
obrigatório

Comprador.

shipping_address
object | null
obrigatório

Endereço de entrega informado no checkout; null quando o pedido não tem endereço.

payment
object
obrigatório

Último pagamento do pedido (o mais recente pela data de criação). Os valores somam as partes pagas só no pagamento dividido (method MULTIPLE); nos demais casos (renovação de assinatura, parcelado inteligente, nova tentativa) são os do último pagamento.

items
object[]
obrigatório

Produtos do pedido.

offer
object | null
obrigatório

Oferta do checkout em que o pedido foi feito; null quando não há.

promocode
object | null
obrigatório

Cupom aplicado no pedido; null sem cupom.

utm
object | null
obrigatório

Parâmetros UTM do checkout; null quando o pedido não tem UTM.

tracking
object | null
obrigatório

Parâmetros de rastreamento que vieram na URL do checkout (ex. sck, src, xcod), como chave → valor. null quando o pedido não tem rastreamento ou quando quem consulta é coprodutor (role: COPRODUCER).

navigator
object | null
obrigatório

Navegador do comprador no checkout. Nunca traz o IP. null quando o pedido não registrou navegador nem página de origem, ou quando quem consulta é coprodutor (role: COPRODUCER).

metadata
object | null
obrigatório

Metadados comerciais do pedido. Cada chave só aparece quando existe no pedido.