idintegerOpcionalSolicitacaoTransporteDetalhe
Estrutura preservada do contrato versionado da API.
Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
public_idstringOpcionalexternal_order_refstring | nullOpcionalsource_systemstring | nullOpcionalchannelstringOpcionalentry_pointstringOpcional"ready_order" · "nfe_received" · "spot_quote_without_nfe"contract_modestringOpcional"period_contract" · "spot"operation_typestringOpcional"urban_delivery" · "closed_load"statesobjectOpcionalrelationshipsobjectOpcionalcommercialobjectOpcionaldemand_offer_integrationobject | nullOpcionalEstado 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).
driver_offer_acceptancesarrayOpcionalEvidências canônicas de aceite explícito individual por motorista autorizado.
executor_allocationsarrayOpcionalAlocações confirmadas de executores individuais (motorista + CNPJ prestador + veículo + unidade de trabalho).
white_label_contextobjectOpcionalContexto autorizado Embarcador + Gestor + relacionamento (CarrierShipper), preservando identidades fiscais e beneficiários reais (marca é estritamente camada visual).
integration_dependenciesobjectOpcionalMapa 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.
Definição JSON Completa
{
"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."
}
}
}