← InicioFleetPay / API

Consultar solicitud de transporte

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/embarcador/solicitacoes-transporte/{id}
consultarSolicitacaoTransporteEmbarcadorBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Devuelve los detalles completos de la solicitud, incluidas las 4 dimensiones de estado, paradas, bultos, documentos fiscales, snapshot comercial y traza de auditoría.

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Contratación Directa (Embarcador)
Perfiles Aplicables
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

idpath · stringObligatorio

public_id (ej.: STR-...), external_order_ref o ID numérico de la solicitud del embarcador.

Restricciones
{
  "type": "string"
}

Respuestas

200 Respuesta HTTP

Detalles de la solicitud de transporte

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

application/json

errorobjectOpcional
403 Respuesta HTTP

Ámbito no habilitado para esta credencial

application/json

errorobjectOpcional
404 Respuesta HTTP

Solicitud no encontrada o perteneciente a otro embarcador

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "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}"
}