← HomeFleetPay / API

Create transport request

Parameters, data structure and responses from the versioned contract.

POST/embarcador/solicitacoes-transporte
criarSolicitacaoTransporteEmbarcadorSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Registers a new transport request for the authenticated shipper (from a ready order, received invoice, or Spot quotation need prior to invoice) and runs initial commercial resolution against authorized Transport Manager links.

This endpoint does not automatically contract the request: after validating commercial terms (contract_identified for period contract or spot_accepted for Spot), call POST /embarcador/solicitacoes-transporte/{id}/contratar.

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

Idempotency-Keyheader · stringOptional

Optional idempotency key (up to 191 characters). Repeating with the same payload returns Idempotent-Replay: true; a different payload with the same key returns 409 Conflict.

Constraints
{
  "type": "string",
  "maxLength": 191
}

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

201 HTTP Response

Request created and classified across the four state dimensions

application/json

successbooleanOptional
commercial_resolutionobject | nullOptional
401 HTTP Response

Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.

application/json

errorobjectOptional
403 HTTP Response

Scope not enabled for these credentials

application/json

errorobjectOptional
409 HTTP Response

Idempotency conflict (idempotency_key_payload_mismatch or idempotency_key_in_progress)

application/json

errorobjectOptional
422 HTTP Response

Request field validation error

application/json

errorobjectOptional
429 HTTP Response

Request limit exceeded (limite_requisicoes). Wait for the interval specified in the Retry-After header before retrying. This may be a limit forwarded from the provider or FleetPay's own anti-abuse limit, counted per authenticated company and route group, with a short window for bursts and a long window for slower automated traffic. Limits are intentionally generous: genuine integrations, including large batches processed at once, should remain well below them. If yours reaches a limit, contact FleetPay.

application/json

errorobjectOptional
Complete Operation Definition
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Criar solicitação de transporte",
  "description": "Registra uma nova solicitação de transporte para o embarcador autenticado (a partir de pedido pronto, nota fiscal recebida ou necessidade de cotação Spot ainda sem nota) e executa a resolução comercial inicial contra os vínculos autorizados com o Gestor de Transporte.\n\nEste endpoint **não** contrata automaticamente a solicitação: após validar as condições comerciais (`contract_identified` em contrato por período ou `spot_accepted` em Spot), chame `POST /embarcador/solicitacoes-transporte/{id}/contratar`.\n",
  "operationId": "criarSolicitacaoTransporteEmbarcador",
  "parameters": [
    {
      "name": "Idempotency-Key",
      "in": "header",
      "required": false,
      "description": "Chave de idempotência opcional (até 191 caracteres). Repetição com o mesmo payload devolve `Idempotent-Replay: true`; payload diferente com a mesma chave responde `409 Conflict`.",
      "schema": {
        "type": "string",
        "maxLength": 191
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CriarSolicitacaoTransporteRequest"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Solicitação criada e classificada nas quatro dimensões de estado",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "409": {
      "description": "Conflito de idempotência (`idempotency_key_payload_mismatch` ou `idempotency_key_in_progress`)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Erro de validação dos campos da solicitação",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "contratacao-direta",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial"
  ],
  "method": "POST",
  "path": "/embarcador/solicitacoes-transporte"
}