← InícioFleetPay / API

Reprocessar itens com falha de um lote sem duplicar itens válidos

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

POST/embarcador/solicitacoes-transporte/lotes/{batchId}/reprocessar
reprocessarLoteSolicitacoesTransporteEmbarcadorBase 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
Restrições
{
  "type": "string"
}

Corpo da Requisição

Opcional

application/json

itemsarrayOpcional

Correções indexadas pelo item_index dos itens com falha.

Respostas

200 Resposta HTTP

Lote reprocessado sem duplicação dos itens anteriormente válidos

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": "Reprocessar itens com falha de um lote sem duplicar itens válidos",
  "operationId": "reprocessarLoteSolicitacoesTransporteEmbarcador",
  "parameters": [
    {
      "name": "batchId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": false,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "items": {
              "type": "array",
              "description": "Correções indexadas pelo `item_index` dos itens com falha.",
              "items": {
                "type": "object",
                "required": [
                  "item_index",
                  "payload"
                ],
                "properties": {
                  "item_index": {
                    "type": "integer"
                  },
                  "payload": {
                    "type": "object"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Lote reprocessado sem duplicação dos itens anteriormente válidos",
      "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": "POST",
  "path": "/embarcador/solicitacoes-transporte/lotes/{batchId}/reprocessar"
}