← InícioFleetPay / API

Importar lote de pedidos (CSV/XLSX) ou notas fiscais (XML/PDF/ZIP)

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

POST/embarcador/solicitacoes-transporte/lotes
importarLoteSolicitacoesTransporteEmbarcadorBase 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.

Processa em lote uma planilha de pedidos (batch_type: order_spreadsheet, CSV ou XLSX) ou arquivos de notas fiscais (batch_type: fiscal_documents, XML, PDF ou ZIP), validando linha a linha / arquivo a arquivo. Linhas válidas geram solicitações rastreáveis (em etapa de pré-contratação, sem contratação silenciosa); linhas inválidas registram diagnóstico estruturado por linha/coluna para correção e reprocessamento sem duplicar itens já criados.

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

Idempotency-Keyheader · stringOpcional
Restrições
{
  "type": "string"
}

Corpo da Requisição

Obrigatório

multipart/form-data

batch_typestringOpcional
"order_spreadsheet" · "fiscal_documents"
carrier_shipper_idinteger | nullOpcional
shipper_negotiation_idinteger | nullOpcional
contract_modestring | nullOpcional
"period_contract" · "spot" · null
operation_typestring | nullOpcional
"urban_delivery" · "closed_load" · "full_load" · null
arquivostring · binaryOpcional
arquivosarrayOpcional

Respostas

201 Resposta HTTP

Lote processado com resumo de linhas válidas e inválidas

application/json

successbooleanOpcional
dataobjectOpcional
422 Resposta HTTP

Arquivo ausente ou inválido

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Importar lote de pedidos (CSV/XLSX) ou notas fiscais (XML/PDF/ZIP)",
  "description": "Processa em lote uma planilha de pedidos (`batch_type: order_spreadsheet`, CSV ou XLSX) ou arquivos de notas fiscais (`batch_type: fiscal_documents`, XML, PDF ou ZIP), validando linha a linha / arquivo a arquivo.\nLinhas válidas geram solicitações rastreáveis (em etapa de pré-contratação, sem contratação silenciosa); linhas inválidas registram diagnóstico estruturado por linha/coluna para correção e reprocessamento sem duplicar itens já criados.\n",
  "operationId": "importarLoteSolicitacoesTransporteEmbarcador",
  "parameters": [
    {
      "name": "Idempotency-Key",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "properties": {
            "batch_type": {
              "type": "string",
              "enum": [
                "order_spreadsheet",
                "fiscal_documents"
              ]
            },
            "carrier_shipper_id": {
              "type": [
                "integer",
                "null"
              ]
            },
            "shipper_negotiation_id": {
              "type": [
                "integer",
                "null"
              ]
            },
            "contract_mode": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "period_contract",
                "spot",
                null
              ]
            },
            "operation_type": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "urban_delivery",
                "closed_load",
                "full_load",
                null
              ]
            },
            "arquivo": {
              "type": "string",
              "format": "binary"
            },
            "arquivos": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Lote processado com resumo de linhas válidas e inválidas",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/LoteSolicitacoesTransporteResponse"
          }
        }
      }
    },
    "422": {
      "description": "Arquivo ausente ou inválido",
      "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": "POST",
  "path": "/embarcador/solicitacoes-transporte/lotes"
}