Skip to main content
GET
Listar as coletas

Authorizations

Authorization
string
header
required

A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.

Query Parameters

limit
integer
default:25

A quantidade de itens da página, de 1 a 100. O padrão é 25.

Required range: 1 <= x <= 100
cursor
string

O valor de next_cursor da página anterior. Sem este parâmetro, a lista começa no item mais novo.

contact_id
string

O id do contato da coleta. O id da pessoa começa com per_, e o id da empresa começa com com_.

tax_id
string

O CPF ou o CNPJ do contato da coleta, com ou sem pontuação.

created_from
string<date>

A primeira data de criação, no formato AAAA-MM-DD. A data usa o fuso horário da organização, e o dia inteiro entra na lista.

created_to
string<date>

A última data de criação, no formato AAAA-MM-DD. A data usa o fuso horário da organização, e o dia inteiro entra na lista.

state
enum<string>

O estado da coleta. O campo state da coleta explica cada valor. O estado da coleta. assembling: a coleta está em montagem e espera os documentos. reviewing: o operador revisa os documentos. ready_to_dispatch: todo documento obrigatório chegou, e nenhuma validação bloqueia a coleta. awaiting_partner: o operador enviou a coleta ao parceiro. cancelled: o operador cancelou a coleta.

Available options:
assembling,
reviewing,
ready_to_dispatch,
awaiting_partner,
cancelled
pack_id
string

O id do pacote que a coleta pede. A coleta sem contato também entra na lista, antes de o destinatário se identificar.

number
string

O protocolo da coleta, ou um número impresso num documento da coleta, como o número da fatura. A busca ignora a diferença entre maiúscula e minúscula. A busca não acha a coleta pelo número que um documento só cita.

Response

Uma página de coletas.

data
object[]
required
has_more
boolean
required

Com true, a lista tem mais itens depois desta página.

next_cursor
string | null
required

O valor do parâmetro cursor para a próxima página. Na última página, o valor é null.