← HomeFleetPay / API

Query status and items of an import batch

Parameters, data structure and responses from the versioned contract.

GET/embarcador/solicitacoes-transporte/lotes/{batchId}
consultarLoteSolicitacoesTransporteEmbarcadorSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Authentication

Required Scope
operacao — Operations
Module
Direct Contracting (Shipper)
Target Profiles
Shipper · Transport Manager · Dedicated Fleet Contractor
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

batchIdpath · stringRequired

public_id (e.g. BAT-...) or numeric ID of the batch.

Constraints
{
  "type": "string"
}

Responses

200 HTTP Response

Batch details and per-item diagnostics

application/json

successbooleanOptional
dataobjectOptional
404 HTTP Response

Batch not found

application/json

errorobjectOptional
Complete Operation Definition
{
  "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}"
}