← HomeFleetPay / API

Validate and calculate commercial terms for the request

Parameters, data structure and responses from the versioned contract.

POST/embarcador/solicitacoes-transporte/{id}/validar-condicoes
validarCondicoesSolicitacaoTransporteEmbarcadorSandbox Base: https://api.fleetpay.site/v1

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

Resolves the active Transport Manager link, checks the formally accepted version (ShipperContractAcceptance), validity window and operational scope (urban_delivery vs closed_load/full_load), computes server-side freight breakdown (including the 3% FleetPay technology fee on the agreed base) and identifies ambiguities when more than one eligible contract/link exists without explicit selection. Services outside the contracted scope route to Spot (spot_requested).

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

idpath · stringRequired
Constraints
{
  "type": "string"
}

Request Body

Optional

application/json

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

Responses

200 HTTP Response

Commercial resolution result and calculation breakdown

application/json

successbooleanOptional
commercial_resolutionobjectOptional
404 HTTP Response

Request not found

application/json

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