curl --request GET \
--url https://app.useqx.com/api/v1/collections/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/collections/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.useqx.com/api/v1/collections/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.useqx.com/api/v1/collections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/collections/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useqx.com/api/v1/collections/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/collections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": [
"INV-81244/2026"
],
"created_at": "2026-09-25T10:31:12.000-03:00",
"ready_at": null,
"documents": [
{
"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
},
{
"id": "doc_318",
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"status": "uploaded",
"has_content": true
}
]
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "A chamada não trouxe uma chave de API válida. Envie a chave no cabeçalho Authorization, no formato Bearer <chave>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "A assinatura da organização está bloqueada. Regularize o pagamento no QX para usar a API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "O plano gratuito não inclui a API. Assine um plano pago no QX para usar a API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "O recurso não existe na organização da chave.",
"code": "not_found"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "A chave passou de um limite por minuto. Espere os segundos do cabeçalho Retry-After e chame de novo.",
"code": "rate_limited"
}Ler uma coleta
Lê uma coleta da organização da chave, com os documentos da coleta. A chamada acha também a coleta arquivada.
curl --request GET \
--url https://app.useqx.com/api/v1/collections/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/collections/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.useqx.com/api/v1/collections/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.useqx.com/api/v1/collections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/collections/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useqx.com/api/v1/collections/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/collections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": [
"INV-81244/2026"
],
"created_at": "2026-09-25T10:31:12.000-03:00",
"ready_at": null,
"documents": [
{
"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
},
{
"id": "doc_318",
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"status": "uploaded",
"has_content": true
}
]
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "A chamada não trouxe uma chave de API válida. Envie a chave no cabeçalho Authorization, no formato Bearer <chave>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "A assinatura da organização está bloqueada. Regularize o pagamento no QX para usar a API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "O plano gratuito não inclui a API. Assine um plano pago no QX para usar a API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "O recurso não existe na organização da chave.",
"code": "not_found"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "A chave passou de um limite por minuto. Espere os segundos do cabeçalho Retry-After e chame de novo.",
"code": "rate_limited"
}Authorizations
A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.
Path Parameters
O id da coleta. O id começa com col_.
Response
A coleta, 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