← InicioFleetPay / API

Consultar estado y elementos de un lote de importación

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

GET/embarcador/solicitacoes-transporte/lotes/{batchId}
consultarLoteSolicitacoesTransporteEmbarcadorBase 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.

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

batchIdpath · stringObligatorio

public_id (ej.: BAT-...) o ID numérico del lote.

Restricciones
{
  "type": "string"
}

Respuestas

200 Respuesta HTTP

Detalles del lote y diagnóstico por elemento

application/json

successbooleanOpcional
dataobjectOpcional
404 Respuesta HTTP

Lote no encontrado

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Consultar status e itens de um lote de importação",
  "operationId": "consultarLoteSolicitacoesTransporteEmbarcador",
  "parameters": [
    {
      "name": "batchId",
      "in": "path",
      "required": true,
      "description": "`public_id` (ex.: `BAT-...`) ou ID numérico do lote.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Detalhes do lote e diagnóstico por item",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/LoteSolicitacoesTransporteResponse"
          }
        }
      }
    },
    "404": {
      "description": "Lote não encontrado",
      "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/lotes/{batchId}"
}