← InícioFleetPay / API

Validar e calcular condições comerciais da solicitação

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

POST/embarcador/solicitacoes-transporte/{id}/validar-condicoes
validarCondicoesSolicitacaoTransporteEmbarcadorBase 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.

Resolve o vínculo ativo com o Gestor de Transporte, verifica a versão formalmente aceita (ShipperContractAcceptance), vigência e escopo operacional (urban_delivery vs closed_load/full_load), calcula a composição do frete no servidor (incluindo a taxa tecnológica FleetPay de 3% sobre a base acordada) e identifica ambiguidades quando houver mais de um contrato/vínculo elegível sem seleção explícita. Serviços fora do escopo contratado são encaminhados para Spot (spot_requested).

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

idpath · stringObrigatório
Restrições
{
  "type": "string"
}

Corpo da Requisição

Opcional

application/json

carrier_shipper_idinteger | nullOpcional
shipper_negotiation_idinteger | nullOpcional
requested_versioninteger | nullOpcional
contract_modestring | nullOpcional
"period_contract" · "spot" · null
operation_typestring | nullOpcional
"urban_delivery" · "closed_load" · "full_load" · null
service_datestring | null · dateOpcional
calculation_inputsobject | nullOpcional

Respostas

200 Resposta HTTP

Resultado da resolução comercial e memória de cálculo

application/json

successbooleanOpcional
commercial_resolutionobjectOpcional
404 Resposta HTTP

Solicitação não encontrada

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Validar e calcular condições comerciais da solicitação",
  "description": "Resolve o vínculo ativo com o Gestor de Transporte, verifica a versão formalmente aceita (`ShipperContractAcceptance`), vigência e escopo operacional (`urban_delivery` vs `closed_load`/`full_load`), calcula a composição do frete no servidor (incluindo a taxa tecnológica FleetPay de 3% sobre a base acordada) e identifica ambiguidades quando houver mais de um contrato/vínculo elegível sem seleção explícita. Serviços fora do escopo contratado são encaminhados para Spot (`spot_requested`).\n",
  "operationId": "validarCondicoesSolicitacaoTransporteEmbarcador",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": false,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ValidarCondicoesTransporteRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Resultado da resolução comercial e memória de cálculo",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ValidarCondicoesTransporteResponse"
          }
        }
      }
    },
    "404": {
      "description": "Solicitação não encontrada",
      "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/{id}/validar-condicoes"
}