← InícioFleetPay / API

Criar solicitação de transporte

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/embarcador/solicitacoes-transporte
criarSolicitacaoTransporteEmbarcadorBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

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.

Este 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.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Contratação Direta (Embarcador)
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Idempotency-Keyheader · stringOpcional

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.

Restrições
{
  "type": "string",
  "maxLength": 191
}

Corpo da Requisição

Obrigatório

application/json

entry_pointstringOpcional
"ready_order" · "nfe_received" · "spot_quote_without_nfe"
external_order_refstring | nullOpcional

Referência externa do pedido no ERP/TMS do embarcador.

maxLength120
source_systemstring | nullOpcional
maxLength80
carrier_shipper_idinteger | nullOpcional

ID do vínculo autorizado com o Gestor de Transporte (carrier_shippers.id). Obrigatório quando houver mais de um vínculo elegível.

shipper_negotiation_idinteger | nullOpcional

ID da negociação/contrato (shipper_negotiations.id). Obrigatório quando houver mais de um contrato elegível.

requested_versioninteger | nullOpcional

Versão comercial solicitada (ex.: 1).

contract_modestringOpcional
"period_contract" · "spot"
operation_typestringOpcional
"urban_delivery" · "closed_load" · "full_load"
service_datestring | null · dateOpcional
origin_citystringOpcional
origin_statestringOpcional
minLength2
maxLength2
origin_postal_codestring | nullOpcional
origin_addressobject | nullOpcional
origin_contactobject | nullOpcional
pickup_window_startstring | null · date-timeOpcional
pickup_window_endstring | null · date-timeOpcional
destination_citystringOpcional
destination_statestringOpcional
minLength2
maxLength2
destination_postal_codestring | nullOpcional
destination_addressobject | nullOpcional
destination_contactobject | nullOpcional
delivery_window_startstring | null · date-timeOpcional
delivery_window_endstring | null · date-timeOpcional
timezonestringOpcional
cargo_descriptionstring | nullOpcional
weight_kgnumber | nullOpcional
minimum0
weight_unitstringOpcional
"kg" · "t"
volumes_countinteger | nullOpcional
minimum1
declared_value_centsinteger | nullOpcional
minimum0
vehicle_requirementsobject | nullOpcional
calculation_inputsobject | nullOpcional

Parâmetros de cálculo da operação (ex.: 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 | nullOpcional
spot_valid_untilstring | null · date-timeOpcional
stopsarrayOpcional
volumesarrayOpcional
documentsarrayOpcional

Respostas

201 Resposta HTTP

Solicitação criada e classificada nas quatro dimensões de estado

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

application/json

errorobjectOpcional
403 Resposta HTTP

Escopo não habilitado para esta credencial

application/json

errorobjectOpcional
409 Resposta HTTP

Conflito de idempotência (idempotency_key_payload_mismatch ou idempotency_key_in_progress)

application/json

errorobjectOpcional
422 Resposta HTTP

Erro de validação dos campos da solicitação

application/json

errorobjectOpcional
429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "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"
}