← InícioFleetPay / API

Consultar status e itens de um lote de importação

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

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

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

batchIdpath · stringObrigatório

public_id (ex.: BAT-...) ou ID numérico do lote.

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

Respostas

200 Resposta HTTP

Detalhes do lote e diagnóstico por item

application/json

successbooleanOpcional
dataobjectOpcional
404 Resposta HTTP

Lote não encontrado

application/json

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