← HomeFleetPay / API

Update transport request prior to contracting

Parameters, data structure and responses from the versioned contract.

PUT/embarcador/solicitacoes-transporte/{id}
atualizarSolicitacaoTransporteEmbarcadorSandbox Base: https://api.fleetpay.site/v1

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.

Authentication

Required Scope
operacao — Operations
Module
Direct Contracting (Shipper)
Target Profiles
Shipper · Transport Manager · Dedicated Fleet Contractor
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

idpath · stringRequired
Constraints
{
  "type": "string"
}
Idempotency-Keyheader · stringOptional
Constraints
{
  "type": "string"
}

Request Body

Required

application/json

entry_pointstringOptional
"ready_order" · "nfe_received" · "spot_quote_without_nfe"
external_order_refstring | nullOptional

External order reference in the shipper's ERP/TMS.

maxLength120
source_systemstring | nullOptional
maxLength80
carrier_shipper_idinteger | nullOptional

Authorized Transport Manager link ID (carrier_shippers.id). Mandatory when more than one eligible link exists.

shipper_negotiation_idinteger | nullOptional

Negotiation/contract ID (shipper_negotiations.id). Mandatory when more than one eligible contract exists.

requested_versioninteger | nullOptional

Requested commercial version (e.g. 1).

contract_modestringOptional
"period_contract" · "spot"
operation_typestringOptional
"urban_delivery" · "closed_load" · "full_load"
service_datestring | null · dateOptional
origin_citystringOptional
origin_statestringOptional
minLength2
maxLength2
origin_postal_codestring | nullOptional
origin_addressobject | nullOptional
origin_contactobject | nullOptional
pickup_window_startstring | null · date-timeOptional
pickup_window_endstring | null · date-timeOptional
destination_citystringOptional
destination_statestringOptional
minLength2
maxLength2
destination_postal_codestring | nullOptional
destination_addressobject | nullOptional
destination_contactobject | nullOptional
delivery_window_startstring | null · date-timeOptional
delivery_window_endstring | null · date-timeOptional
timezonestringOptional
cargo_descriptionstring | nullOptional
weight_kgnumber | nullOptional
minimum0
weight_unitstringOptional
"kg" · "t"
volumes_countinteger | nullOptional
minimum1
declared_value_centsinteger | nullOptional
minimum0
vehicle_requirementsobject | nullOptional
calculation_inputsobject | nullOptional

Operation 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 | nullOptional
spot_valid_untilstring | null · date-timeOptional
stopsarrayOptional
volumesarrayOptional
documentsarrayOptional

Responses

200 HTTP Response

Request updated

application/json

successbooleanOptional
commercial_resolutionobject | nullOptional
404 HTTP Response

Request not found

application/json

errorobjectOptional
409 HTTP Response

Request already contracted or idempotency conflict

application/json

errorobjectOptional
422 HTTP Response

Validation error

application/json

errorobjectOptional
Complete Operation Definition
{
  "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}"
}