curl --request POST \
--url https://app.useqx.com/api/v1/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pack_id": "pck_12",
"contact_id": "com_12"
}
'{
"id": "col_40",
"protocol": "DOC-2026-00123",
"state": "assembling",
"discarded": false,
"contact": {
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda"
},
"recipient": null,
"packs": [
{
"id": "pck_12",
"name": "Importação marítima"
}
],
"numbers": [],
"created_at": "2026-09-25T10:31:12.000-03:00",
"ready_at": null,
"documents": [
{
"id": "doc_310",
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"status": "pending",
"has_content": false
},
{
"id": "doc_311",
"document_type": {
"id": "dtp_32",
"name": "Bill of Lading (B/L)"
},
"status": "pending",
"has_content": false
},
{
"id": "doc_312",
"document_type": {
"id": "dtp_33",
"name": "Romaneio de Carga (Packing List)"
},
"status": "pending",
"has_content": false
}
]
}Criar uma coleta
Cria uma coleta com um pacote. Com um contato, a coleta nasce com os slots dos requisitos do pacote. Sem contato, a API cria a coleta para um destinatário e manda o convite ao e-mail dele. Os slots nascem depois que o destinatário se identifica no portal. A criação conta no limite de escritas pagas da chave.
curl --request POST \
--url https://app.useqx.com/api/v1/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pack_id": "pck_12",
"contact_id": "com_12"
}
'{
"id": "col_40",
"protocol": "DOC-2026-00123",
"state": "assembling",
"discarded": false,
"contact": {
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda"
},
"recipient": null,
"packs": [
{
"id": "pck_12",
"name": "Importação marítima"
}
],
"numbers": [],
"created_at": "2026-09-25T10:31:12.000-03:00",
"ready_at": null,
"documents": [
{
"id": "doc_310",
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"status": "pending",
"has_content": false
},
{
"id": "doc_311",
"document_type": {
"id": "dtp_32",
"name": "Bill of Lading (B/L)"
},
"status": "pending",
"has_content": false
},
{
"id": "doc_312",
"document_type": {
"id": "dtp_33",
"name": "Romaneio de Carga (Packing List)"
},
"status": "pending",
"has_content": false
}
]
}Authorizations
A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.
Headers
Um valor único que o seu sistema cria para cada escrita, como um UUID. A chamada repetida com o mesmo valor e o mesmo conteúdo recebe a primeira resposta e não grava nada de novo. A API guarda a resposta por 24 horas.
1 - 255Body
O id do pacote da coleta. O pacote precisa estar ativo.
"pck_12"
O id do contato da coleta. Informe o contact_id ou o tax_id, só um dos dois.
"com_12"
O CPF ou o CNPJ do contato da coleta, com ou sem pontuação. Informe o contact_id ou o tax_id, só um dos dois.
"12.345.678/0001-95"
O destinatário da coleta sem contato. Ele recebe o convite e se identifica no portal com o CPF ou o CNPJ. Informe o destinatário só quando a chamada não traz contact_id nem tax_id.
Show child attributes
Show child attributes
Com true, o QX cria o convite e manda ao contato o e-mail com o link do portal. O valor vale só para a coleta com contato. Na coleta sem contato, o QX sempre manda o convite ao destinatário.
Response
A coleta criada, com os documentos.
Uma coleta, com a lista de documentos.
O id da coleta.
^col_[1-9][0-9]*$"col_40"
O protocolo da coleta.
"DOC-2026-00123"
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.
assembling, reviewing, ready_to_dispatch, awaiting_partner, cancelled Com true, a coleta está arquivada.
O contato da coleta. O valor é null na coleta sem contato, até o destinatário se identificar.
Show child attributes
Show child attributes
O destinatário da coleta criada sem contato. Na coleta criada com contato, o valor é null.
Show child attributes
Show child attributes
Os pacotes que a coleta pede.
Show child attributes
Show child attributes
Os números da operação, como a tela da coleta mostra. A lista traz os números impressos nos documentos dos requisitos identificadores do pacote. Sem esses números, a lista traz os números impressos nos outros documentos da coleta. Na coleta sem pacote de operação, a lista é vazia.
["INV-81244/2026"]
A data e a hora da criação, no fuso horário da organização.
"2026-09-25T10:30:00.000-03:00"
A data e a hora em que a coleta ficou pronta pela última vez, no fuso horário da organização. O valor é null quando a coleta nunca ficou pronta.
Os documentos da coleta, do mais antigo ao mais novo. O documento descartado fica de fora.
Show child attributes
Show child attributes