← InícioFleetPay / API

Consultar solicitação de transporte

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/embarcador/solicitacoes-transporte/{id}
consultarSolicitacaoTransporteEmbarcadorBase de Homologação: https://api.fleetpay.site/v1

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.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Contratação Direta (Embarcador)
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

idpath · stringObrigatório

public_id (ex.: STR-...), external_order_ref ou ID numérico da solicitação do embarcador.

Restrições
{
  "type": "string"
}

Respostas

200 Resposta HTTP

Detalhes da solicitação de transporte

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
401 Resposta HTTP

Nã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.

application/json

errorobjectOpcional
403 Resposta HTTP

Escopo não habilitado para esta credencial

application/json

errorobjectOpcional
404 Resposta HTTP

Solicitação não encontrada ou pertencente a outro embarcador

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "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}"
}