idpath · stringRequiredpublic_id (e.g. STR-...), external_order_ref or numeric ID of the shipper request.
Constraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/embarcador/solicitacoes-transporte/{id}Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Returns full details of the transport request, including the 4 state dimensions, stops, volumes, tax documents, commercial snapshot and audit trail.
operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringRequiredpublic_id (e.g. STR-...), external_order_ref or numeric ID of the shipper request.
{
"type": "string"
}200 HTTP ResponseTransport request details
application/jsonsuccessbooleanOptionaldataobjectOptionalcommercial_resolutionobject | nullOptional401 HTTP ResponseUnauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.
404 HTTP ResponseRequest not found or belongs to another shipper
{
"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}"
}