idpath · stringObrigatóriopublic_id (ex.: STR-...), external_order_ref ou ID numérico da solicitação do embarcador.
Restrições
{
"type": "string"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/embarcador/solicitacoes-transporte/{id}Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Retorna os detalhes completos da solicitação, incluindo as 4 dimensões de estado, paradas, volumes, documentos fiscais, snapshot comercial e trilha de auditoria.
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringObrigatóriopublic_id (ex.: STR-...), external_order_ref ou ID numérico da solicitação do embarcador.
{
"type": "string"
}200 Resposta HTTPDetalhes da solicitação de transporte
application/jsonsuccessbooleanOpcionaldataobjectOpcionalcommercial_resolutionobject | nullOpcional401 Resposta HTTPNão autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.
403 Resposta HTTPEscopo não habilitado para esta credencial
404 Resposta HTTPSolicitação não encontrada ou pertencente a outro embarcador
{
"tags": [
"Solicitações e Contratação de Transporte (Embarcador)"
],
"summary": "Consultar solicitação de transporte",
"description": "Retorna os detalhes completos da solicitação, incluindo as 4 dimensões de estado, paradas, volumes, documentos fiscais, snapshot comercial e trilha de auditoria.",
"operationId": "consultarSolicitacaoTransporteEmbarcador",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "`public_id` (ex.: `STR-...`), `external_order_ref` ou ID numérico da solicitação do embarcador.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Detalhes da solicitação de transporte",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SolicitacaoTransporteResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/Erro401"
},
"403": {
"$ref": "#/components/responses/Erro403"
},
"404": {
"description": "Solicitação não encontrada ou pertencente a outro embarcador",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "contratacao-direta",
"x-fleetpay-profiles": [
"embarcador",
"gestor",
"agregado_empresarial"
],
"method": "GET",
"path": "/embarcador/solicitacoes-transporte/{id}"
}