Skip to main content
GET

Comportamento

Retorna pedidos que o integrador deve processar ou reconhecer. Modelo pull cursor-based: você consulta periodicamente com um cursor (updated_since) e recebe as mudanças em ordem cronológica.

Filtros implícitos (sem override)

  • status IN ('pagamento_aprovado', 'em_separacao', 'enviado', 'entregue', 'cancelado')
  • Pedido tem pelo menos 1 item cuja variante tem hunter_id preenchido (filtro em cascata — evita mostrar pedidos que o integrador não sabe processar)
Dentro do pedido, só os itens com hunter_id aparecem (filtro em cascata). Se pedido tem 5 itens mas só 3 têm variante do integrador, o response traz apenas os 3.

Query params

string (ISO 8601 UTC)
Retorna pedidos com atualizado_em > updated_since. Sem este parâmetro no primeiro pull, retorna tudo (respeitando limit).
integer
default:"50"
Máx 200 por request.

Ordenação

atualizado_em ASC — cursor incremental. O último pedido do response tem o maior atualizado_em; use-o como próximo updated_since.

Payload de cada pedido

string
required
Código público do pedido (ex: PED-000123). Use nas rotas /processado e /rastreio.
string
required
Um de: pagamento_aprovado, em_separacao, enviado, entregue, cancelado.
string (ISO 8601 UTC)
required
string (ISO 8601 UTC)
required
Cursor pro próximo pull. Guarde o valor do último pedido retornado.
string | null
string | null
required
Timestamp de quando o integrador chamou POST /processado. null se ainda não processou. Use pra ignorar replays — se preenchido, você já processou este pedido em algum pull anterior.
number
required
number
required
number
required
number
required
string | null
string | null
required
Um de: pix, boleto, cartao. Nunca inclui dados de cartão (número, CVV, bandeira).
object
required
Dados fiscais do cliente. Discrimina PF/PJ.
object | null
required
array
required
Apenas itens com variante.hunter_id preenchido.
object | null
required
Preenchido apenas quando status IN ('enviado', 'entregue') E existe código de rastreio.
object | null
required
Preenchido apenas quando status='cancelado'.

Discriminação por status

Como usar o campo status + hunter_processado_em no lado do integrador:

Paginação com cursor

Não use page — use updated_since como cursor incremental:

Regras adicionais

  • forma_pagamento é sempre "pix" | "boleto" | "cartao". Nunca inclui dados sensíveis.
  • endereco_entrega.razao_social (quando presente) deve ser usado como destinatário principal da etiqueta postal, com A/C: {destinatario_do_endereco} como complemento.
  • Se pedido.hunter_processado_em está preenchido e você recebeu o pedido de novo, é replay — ignore.