idpath · stringRequiredConstraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/embarcador/solicitacoes-transporte/{id}Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Updates operational, tax or manager link fields and re-evaluates commercial resolution. Blocked (409) if the request is already contracted.
operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringRequired{
"type": "string"
}Idempotency-Keyheader · stringOptional{
"type": "string"
}Required
application/jsonentry_pointstringOptional"ready_order" · "nfe_received" · "spot_quote_without_nfe"external_order_refstring | nullOptionalExternal order reference in the shipper's ERP/TMS.
maxLength120source_systemstring | nullOptionalmaxLength80carrier_shipper_idinteger | nullOptionalAuthorized Transport Manager link ID (carrier_shippers.id). Mandatory when more than one eligible link exists.
shipper_negotiation_idinteger | nullOptionalNegotiation/contract ID (shipper_negotiations.id). Mandatory when more than one eligible contract exists.
requested_versioninteger | nullOptionalRequested commercial version (e.g. 1).
contract_modestringOptional"period_contract" · "spot"operation_typestringOptional"urban_delivery" · "closed_load" · "full_load"service_datestring | null · dateOptionalorigin_citystringOptionalorigin_statestringOptionalminLength2maxLength2origin_postal_codestring | nullOptionalorigin_addressobject | nullOptionalorigin_contactobject | nullOptionalpickup_window_startstring | null · date-timeOptionalpickup_window_endstring | null · date-timeOptionaldestination_citystringOptionaldestination_statestringOptionalminLength2maxLength2destination_postal_codestring | nullOptionaldestination_addressobject | nullOptionaldestination_contactobject | nullOptionaldelivery_window_startstring | null · date-timeOptionaldelivery_window_endstring | null · date-timeOptionaltimezonestringOptionalcargo_descriptionstring | nullOptionalweight_kgnumber | nullOptionalminimum0weight_unitstringOptional"kg" · "t"volumes_countinteger | nullOptionalminimum1declared_value_centsinteger | nullOptionalminimum0vehicle_requirementsobject | nullOptionalcalculation_inputsobject | nullOptionalOperation calculation parameters (e.g. deliveries_count, Sundays_deliveries_count, After_hours_deliveries_count, package_overweight_kg, freight_value_cents, km, toll_cents, has_helper, has_escort, dedicated_vehicle).
spot_requirementsobject | nullOptionalspot_valid_untilstring | null · date-timeOptionalstopsarrayOptionalvolumesarrayOptionaldocumentsarrayOptional200 HTTP ResponseRequest updated
application/jsonsuccessbooleanOptionaldataobjectOptionalcommercial_resolutionobject | nullOptional409 HTTP ResponseRequest already contracted or idempotency conflict
{
"tags": [
"Solicitações e Contratação de Transporte (Embarcador)"
],
"summary": "Atualizar solicitação de transporte antes da contratação",
"description": "Atualiza dados operacionais, fiscais ou vínculo com o gestor e revalida a resolução comercial. Bloqueado (`409`) se a solicitação já estiver contratada.",
"operationId": "atualizarSolicitacaoTransporteEmbarcador",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CriarSolicitacaoTransporteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Solicitação atualizada",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SolicitacaoTransporteResponse"
}
}
}
},
"404": {
"description": "Solicitação não encontrada",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"409": {
"description": "Solicitação já contratada ou conflito de idempotência",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Erro"
}
}
}
},
"422": {
"description": "Erro de validação",
"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": "PUT",
"path": "/embarcador/solicitacoes-transporte/{id}"
}