Skip to main content

GET Listar Envios

Lista os envios feitos para a Conta Azul. Paginado e isolado por conta. Não retorna o payload do envio, que carrega dados do paciente.

Ainda não disponível em produção

Esta rota existe na develop e ainda não foi publicada na main.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão read_movements.


Endpoint​

GET https://api-dev.imagemais.com.br/api/integrations/conta-azul/deliveries

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
limitnumber❌inteiro; mín. 0; máx. 100Número de itens retornados a cada página
offsetnumber❌inteiro; mín. 0Número da página atual
statestring❌PENDING, SENT, FAILEDFiltra pelo estado do envio
needsReversalboolean❌—Somente envios que precisam de estorno manual
startDatestring❌data ISO 8601Data inicial (YYYY-MM-DD)
endDatestring❌data ISO 8601Data final (YYYY-MM-DD)

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/integrations/conta-azul/deliveries' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": [],
"total": 0,
"limit": 50,
"offset": 0
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

500 Erro interno​

{
"message": "Erro ao listar os envios para a Conta Azul",
"error": "Internal Server Error",
"statusCode": 500
}