idpath · stringObligatorioRestricciones
{
"type": "string"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/embarcador/solicitacoes-transporte/{id}Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Actualiza datos operativos, fiscales o el vínculo con el gestor y revalida la resolución comercial. Bloqueado (409) si la solicitud ya está contratada.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringObligatorio{
"type": "string"
}Idempotency-Keyheader · stringOpcional{
"type": "string"
}Obligatorio
application/jsonentry_pointstringOpcional"ready_order" · "nfe_received" · "spot_quote_without_nfe"external_order_refstring | nullOpcionalReferencia externa del pedido en el ERP/TMS del embarcador.
maxLength120source_systemstring | nullOpcionalmaxLength80carrier_shipper_idinteger | nullOpcionalID del vínculo autorizado con el Gestor de Transporte (carrier_shippers.id). Obligatorio cuando exista más de un vínculo elegible.
shipper_negotiation_idinteger | nullOpcionalID de la negociación/contrato (shipper_negotiations.id). Obligatorio cuando exista más de un contrato elegible.
requested_versioninteger | nullOpcionalVersión comercial solicitada (ej.: 1).
contract_modestringOpcional"period_contract" · "spot"operation_typestringOpcional"urban_delivery" · "closed_load" · "full_load"service_datestring | null · dateOpcionalorigin_citystringOpcionalorigin_statestringOpcionalminLength2maxLength2origin_postal_codestring | nullOpcionalorigin_addressobject | nullOpcionalorigin_contactobject | nullOpcionalpickup_window_startstring | null · date-timeOpcionalpickup_window_endstring | null · date-timeOpcionaldestination_citystringOpcionaldestination_statestringOpcionalminLength2maxLength2destination_postal_codestring | nullOpcionaldestination_addressobject | nullOpcionaldestination_contactobject | nullOpcionaldelivery_window_startstring | null · date-timeOpcionaldelivery_window_endstring | null · date-timeOpcionaltimezonestringOpcionalcargo_descriptionstring | nullOpcionalweight_kgnumber | nullOpcionalminimum0weight_unitstringOpcional"kg" · "t"volumes_countinteger | nullOpcionalminimum1declared_value_centsinteger | nullOpcionalminimum0vehicle_requirementsobject | nullOpcionalcalculation_inputsobject | nullOpcionalParámetros de cálculo de la operación (ej.: 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 | nullOpcionalspot_valid_untilstring | null · date-timeOpcionalstopsarrayOpcionalvolumesarrayOpcionaldocumentsarrayOpcional200 Respuesta HTTPSolicitud actualizada
application/jsonsuccessbooleanOpcionaldataobjectOpcionalcommercial_resolutionobject | nullOpcional409 Respuesta HTTPSolicitud ya contratada o conflicto de idempotencia
{
"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}"
}