Pesquisar pedidos

post

https://api.pre.credix.finance/v2/orders/search

Pesquisa pedidos por diversos critérios.

O parâmetro query aceita:

ID do pedido (UUID)
CNPJ do comprador (14 dígitos; pontos, hífens e barras são ignorados)
Nome do comprador (busca parcial)
ID externo do pedido (busca parcial)
Chave de acesso da NF-e (NFe + 44 dígitos) ou da NFS-e (NFS + 50 dígitos)
Chave de acesso sem o prefixo, com ou sem espaços — busca parcial, pode retornar outras notas do mesmo emitente
Número da nota fiscal (nNF, até 10 dígitos — busca parcial)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

query

string

required

A consulta a ser pesquisada.

batchId

string

Filtra pedidos pelo identificador do lote.

status

array of arrays

Considerar apenas pedidos com estes status.

status

createdAfter

date-time

Considerar apenas pedidos criados em ou após esta data.

createdBefore

date-time

Considerar apenas pedidos criados antes ou em esta data.

page

number

≥ 1

Defaults to 1

Qual página retornar da lista de pedidos. Começa em 1.

take

number

1 to 100

Defaults to 20

Limite de pedidos a serem retornados.

taxId

object

Filtro de Tax ID do comprador.

anticipation

string

enum

Filtrar por antecipação. 'with' = pedidos antecipados (OnAssetCreation); 'without' = pedidos não antecipados (OnAssetDueDate ou OnBuyerPayment). Omitir retorna todos.

Allowed:

disbursementType

string

enum

Filtrar por tipo de desembolso. Upfront = antecipado; OnDueDate = pós-vencimento; OnBuyerPayment = pós-pagamento. Os valores anteriores (Anticipated, Scheduled, OnPayment) continuam aceitos como sinônimos. Omitir retorna todos.

Allowed:

displayStatus

array of strings

Filtro pelo status efetivo exibido na coluna Status da lista. Aceita status de ciclo de vida e estados de desembolso; multi-select = união, igual ao filtro status. Supersede status para a UI da lista — os valores casam exatamente com o que a coluna mostra.

displayStatus

Response

200Operação bem-sucedida.