← InicioFleetPay / Schema

ContratarSolicitacaoTransporteRequest

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

carrier_shipper_idinteger | nullOpcional
shipper_negotiation_idinteger | nullOpcional
requested_versioninteger | nullOpcional
contract_acceptance_idinteger | nullOpcional
acceptedboolean | nullOpcional

No sustituye al término de aceptación formal (ShipperContractAcceptance). Si se envía como true sin evidencia formal de aceptación para la versión comercial, la API rechaza con 422 spot_formal_acceptance_required.

confirm_uncertaintiesboolean | nullOpcional
expected_amount_centsinteger | nullOpcional

Valor total esperado en centavos (opcional). Si se informa y diverge del cálculo canónico del servidor para la versión comercial aceptada, la API responde 409 price_mismatch_with_server_calculation.

aggregated_carrier_company_idinteger | nullOpcional

ID opcional del Transportador Agregado indicado (indicated_aggregated_carrier_company_id). No confirma la atención operacional por sí solo; attendance_status permanece awaiting_confirmation hasta confirmación por el Gestor de Transporte autorizado.

Definición JSON Original (Descripciones en Portugués)
{
  "type": "object",
  "properties": {
    "carrier_shipper_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "shipper_negotiation_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "requested_version": {
      "type": [
        "integer",
        "null"
      ]
    },
    "contract_acceptance_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "accepted": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Não substitui o termo de aceite formal (`ShipperContractAcceptance`). Se enviado como `true` sem evidência formal de aceite para a versão comercial, a API recusa com `422 spot_formal_acceptance_required`."
    },
    "confirm_uncertainties": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "expected_amount_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Valor total esperado em centavos (opcional). Se informado e divergir do cálculo canônico do servidor para a versão comercial aceita, a API responde `409 price_mismatch_with_server_calculation`."
    },
    "aggregated_carrier_company_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "ID opcional do Transportador Agregado indicado (`indicated_aggregated_carrier_company_id`). Não confirma o atendimento operacional por si só; `attendance_status` permanece `awaiting_confirmation` até confirmação pelo Gestor de Transporte autorizado."
    }
  }
}