← InicioFleetPay / Schema

SolicitacaoTransporteDetalhe

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.

idintegerOpcional
public_idstringOpcional
external_order_refstring | nullOpcional
source_systemstring | nullOpcional
channelstringOpcional
entry_pointstringOpcional
"ready_order" · "nfe_received" · "spot_quote_without_nfe"
contract_modestringOpcional
"period_contract" · "spot"
operation_typestringOpcional
"urban_delivery" · "closed_load"
statesobjectOpcional
relationshipsobjectOpcional
commercialobjectOpcional
demand_offer_integrationobject | nullOpcional

Estado canónico de integración de la demanda con el servicio central de Programación de Envío de Ofertas (Gestión de Ofertas y Negociaciones).

driver_offer_acceptancesarrayOpcional

Evidencias canónicas de aceptación explícita individual por conductor autorizado.

executor_allocationsarrayOpcional

Asignaciones confirmadas de ejecutores individuales (conductor + CNPJ prestador + vehículo + unidad de trabajo).

white_label_contextobjectOpcional

Contexto autorizado Embarcador + Gestor + relación (CarrierShipper), preservando identidades fiscales y beneficiarios reales (la marca es estrictamente una capa visual).

integration_dependenciesobjectOpcional

Mapa de integración y dependencias concretas con los módulos Agregados, Gestión de Ofertas y Negociaciones, Automatización Fiscal y White Label.

Definición JSON Original (Descripciones en Portugués)
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "public_id": {
      "type": "string"
    },
    "external_order_ref": {
      "type": [
        "string",
        "null"
      ]
    },
    "source_system": {
      "type": [
        "string",
        "null"
      ]
    },
    "channel": {
      "type": "string"
    },
    "entry_point": {
      "type": "string",
      "enum": [
        "ready_order",
        "nfe_received",
        "spot_quote_without_nfe"
      ]
    },
    "contract_mode": {
      "type": "string",
      "enum": [
        "period_contract",
        "spot"
      ]
    },
    "operation_type": {
      "type": "string",
      "enum": [
        "urban_delivery",
        "closed_load"
      ]
    },
    "states": {
      "type": "object",
      "properties": {
        "intake_status": {
          "type": "string",
          "enum": [
            "draft",
            "received",
            "pending_data",
            "validated",
            "cancelled"
          ]
        },
        "commercial_status": {
          "type": "string",
          "enum": [
            "pending_resolution",
            "contract_identified",
            "ambiguous_contract",
            "ambiguity_blocked",
            "out_of_scope_spot_required",
            "spot_requested",
            "spot_proposal_ready",
            "spot_accepted",
            "pending_acceptance",
            "contracted",
            "revision_requested",
            "cancelled"
          ]
        },
        "attendance_status": {
          "type": "string",
          "enum": [
            "not_requested",
            "awaiting_confirmation",
            "manager_committed",
            "awaiting_driver_acceptance",
            "partially_confirmed",
            "confirmed",
            "declined",
            "in_transit",
            "completed",
            "cancelled"
          ]
        },
        "fiscal_status": {
          "type": "string",
          "enum": [
            "awaiting_nfe",
            "not_required_yet",
            "nfe_received_pending_confirmation",
            "pending_nfe",
            "nfe_validated",
            "nfe_linked",
            "ready_for_cte_prefill",
            "ready_for_cte",
            "cte_prefilled",
            "cte_issuing",
            "cte_authorized",
            "cte_rejected",
            "cte_timeout",
            "cancelled"
          ]
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "shipper_company_id": {
          "type": "integer"
        },
        "manager_company_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "carrier_shipper_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "shipper_negotiation_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "aggregated_carrier_company_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "indicated_aggregated_carrier_company_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "freight_order_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "shipper_managed_operation_id": {
          "type": [
            "integer",
            "null"
          ]
        }
      }
    },
    "commercial": {
      "type": "object",
      "properties": {
        "requested_version": {
          "type": [
            "integer",
            "null"
          ]
        },
        "contracted_version": {
          "type": [
            "integer",
            "null"
          ]
        },
        "contract_acceptance_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "calculated_gross_cents": {
          "type": [
            "integer",
            "null"
          ]
        },
        "calculated_fleetpay_fee_cents": {
          "type": [
            "integer",
            "null"
          ]
        },
        "calculated_total_cents": {
          "type": [
            "integer",
            "null"
          ]
        },
        "fleetpay_fee_rate_percent": {
          "type": "number"
        },
        "calculation_snapshot": {
          "type": [
            "object",
            "null"
          ]
        },
        "contracted_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      }
    },
    "demand_offer_integration": {
      "type": [
        "object",
        "null"
      ],
      "description": "Estado canônico de integração da demanda com o serviço central de Programação de Envio de Ofertas (Gestão de Ofertas e Negociações).",
      "properties": {
        "demand_schedule_type": {
          "type": "string",
          "enum": [
            "variable",
            "fixed_scheduled",
            "mixed"
          ]
        },
        "operational_base_code": {
          "type": "string"
        },
        "window_shift_code": {
          "type": "string"
        },
        "deliveries_count": {
          "type": "integer"
        },
        "required_vacancies_count": {
          "type": "integer"
        },
        "deliveries_per_driver_rule": {
          "type": [
            "integer",
            "null"
          ]
        },
        "vacancy_resolution_mode": {
          "type": "string"
        },
        "demand_version": {
          "type": "integer"
        },
        "demand_revision_mode": {
          "type": "string",
          "enum": [
            "initial",
            "complement",
            "total_revision",
            "incorporate_into_work_unit"
          ]
        },
        "idempotent_replay": {
          "type": "boolean"
        },
        "reduction_after_acceptance": {
          "type": "boolean"
        },
        "cancellation_requested_after_acceptance": {
          "type": "boolean"
        },
        "accepted_vacancies_count": {
          "type": "integer"
        },
        "open_vacancies_count": {
          "type": "integer"
        }
      }
    },
    "driver_offer_acceptances": {
      "type": "array",
      "description": "Evidências canônicas de aceite explícito individual por motorista autorizado.",
      "items": {
        "type": "object",
        "properties": {
          "acceptance_id": {
            "type": "string"
          },
          "driver_user_id": {
            "type": "integer"
          },
          "driver_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "driver_cpf": {
            "type": [
              "string",
              "null"
            ]
          },
          "aggregated_carrier_company_id": {
            "type": "integer"
          },
          "aggregated_carrier_cnpj": {
            "type": [
              "string",
              "null"
            ]
          },
          "aggregated_carrier_legal_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "vehicle_id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "vehicle_plate": {
            "type": [
              "string",
              "null"
            ]
          },
          "vehicle_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "conditions_version": {
            "type": "integer"
          },
          "work_unit_key": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "accepted_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "executor_allocations": {
      "type": "array",
      "description": "Alocações confirmadas de executores individuais (motorista + CNPJ prestador + veículo + unidade de trabalho).",
      "items": {
        "type": "object"
      }
    },
    "white_label_context": {
      "type": "object",
      "description": "Contexto autorizado Embarcador + Gestor + relacionamento (`CarrierShipper`), preservando identidades fiscais e beneficiários reais (marca é estritamente camada visual).",
      "properties": {
        "authorization_basis": {
          "type": "string"
        },
        "brand_is_visual_layer_only": {
          "type": "boolean"
        },
        "slug_authorization_allowed": {
          "type": "boolean"
        }
      }
    },
    "integration_dependencies": {
      "type": "object",
      "description": "Mapa de integração e dependências concretas com as sessões Agregados, Gestão de Ofertas e Negociações, Automação Fiscal e White Label."
    }
  }
}