Skip to main content
GET
Listar pedidos
Retorna o histórico de pedidos dos merchants vinculados à sua aplicação, no contexto CRM — esta rota serve para análise e relacionamento com o cliente, não para o ciclo operacional do pedido (aceite, despacho, entrega). A lista vem ordenada da venda mais recente para a mais antiga.
Envelope plano (items, page, pageSize, total); pageSize padrão 50, máximo 500. O campo storeId identifica o merchant dono de cada pedido — o mesmo id de Listar merchants.
Todos os valores monetários são em centavos (totalAmount e unitPrice): R$ 75,90 chega como 7590. Divida por 100 antes de exibir.
createdAt e updatedAt vêm em UTC (offset +00:00). Para bater com o dashboard da Repediu, converta para o fuso da loja (America/Sao_Paulo) antes de agrupar por dia ou mês — agrupar pelo valor UTC cru desloca a janela em 3 horas e os totais divergem nas bordas do período. Os filtros seguem lógicas diferentes: createdFrom/createdTo filtram pela data da venda no fuso da loja (envie offset explícito, ex. -03:00); updatedFrom/updatedTo comparam em UTC.

Modalidade (originChannel)

originChannel é a modalidade do pedido, num enum fechado — use-o também como filtro:

Filtros

  • Por merchant: storeId (opcional) restringe a um único estabelecimento — o mesmo id de Listar merchants. Omitido, retorna os pedidos de todos os merchants do escopo; um storeId inexistente ou fora do escopo responde 404 com Merchant not found..
  • Por cliente: customerIdentifierType + customerIdentifierValue (sempre em par) — custom busca pelo id do cliente na Repediu (o valor de customer.identifier nas respostas); phone, email, document e external_id seguem como entrada de busca.
  • Sincronização incremental: janelas createdFrom/createdTo (data da venda) e updatedFrom/updatedTo (última atualização), inclusive nas duas pontas.

O que vem em metadata

Cada pedido traz metadata.channel com a modalidade/canal da venda como texto livre (o nome do canal registrado na origem), ou null quando a venda não informou canal. Diferente de originChannel — que é um enum fechado e serve de filtro — o channel preserva o valor original, útil para relatórios que precisam do nome exato do canal.

Erros

Obter pedido

Detalhe de um pedido pelo id retornado nesta listagem.

Autorizações

Authorization
string
header
obrigatório

Token de acesso emitido por POST /od/v2/oauth/token (fluxo client_credentials). Envie no header Authorization como Bearer <token>.

Parâmetros de consulta

storeId
string<uuid>

Restringe a lista a um único merchant. Omitido, retorna os pedidos de todos os merchants do escopo. Id inexistente ou fora do escopo responde 404.

customerIdentifierType
enum<string>

Tipo do identificador para busca. Use custom para buscar pelo id do cliente na Repediu. Exige customerIdentifierValue.

Opções disponíveis:
phone,
email,
document,
external_id,
custom
customerIdentifierValue
string

Valor do identificador canônico (obrigatório quando customerIdentifierType é informado).

originChannel
enum<string>

Filtra pela modalidade do pedido.

Opções disponíveis:
own_app,
marketplace,
in_store,
qr_code,
kiosk,
delivery,
takeout,
other
createdFrom
string<date-time>

Início da janela de criação (inclusive). Deve ser anterior ou igual a createdTo. Filtra pela data da venda no fuso da loja (America/Sao_Paulo) — envie offset explícito (ex. -03:00).

createdTo
string<date-time>

Fim da janela de criação (inclusive). Filtra pela data da venda no fuso da loja (America/Sao_Paulo) — envie offset explícito (ex. -03:00).

updatedFrom
string<date-time>

Início da janela de atualização (inclusive). Deve ser anterior ou igual a updatedTo. Comparado em UTC.

updatedTo
string<date-time>

Fim da janela de atualização (inclusive). Comparado em UTC.

Page
integer<int32>
padrão:1

Página, iniciando em 1.

PageSize
integer<int32>
padrão:50

Itens por página. Valores acima de 500 são limitados a 500.

Intervalo obrigatório: x <= 500

Resposta

Página de pedidos do escopo da aplicação, ordenada da data de venda mais recente para a mais antiga.

items
object[]
page
integer<int32>
pageSize
integer<int32>
total
integer<int32>

Total de registros que atendem ao filtro, considerando todas as páginas.