← InicioFleetPay / API

Crear solicitud de transporte

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/embarcador/solicitacoes-transporte
criarSolicitacaoTransporteEmbarcadorBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Registra una nueva solicitud de transporte para el embarcador autenticado (a partir de pedido listo, factura recibida o necesidad de cotización Spot aún sin factura) y ejecuta la resolución comercial inicial contra los vínculos autorizados con el Gestor de Transporte.

Este endpoint no contrata automáticamente la solicitud: tras validar las condiciones comerciales (contract_identified en contrato por período o spot_accepted en Spot), invoque POST /embarcador/solicitacoes-transporte/{id}/contratar.

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Contratación Directa (Embarcador)
Perfiles Aplicables
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

Idempotency-Keyheader · stringOpcional

Clave de idempotencia opcional (hasta 191 caracteres). La repetición con el mismo payload devuelve Idempotent-Replay: true; payload distinto con la misma clave responde 409 Conflict.

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

Cuerpo de la Solicitud

Obligatorio

application/json

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

Referencia externa del pedido en el ERP/TMS del embarcador.

maxLength120
source_systemstring | nullOpcional
maxLength80
carrier_shipper_idinteger | nullOpcional

ID 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 | nullOpcional

ID de la negociación/contrato (shipper_negotiations.id). Obligatorio cuando exista más de un contrato elegible.

requested_versioninteger | nullOpcional

Versión comercial solicitada (ej.: 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 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 | nullOpcional
spot_valid_untilstring | null · date-timeOpcional
stopsarrayOpcional
volumesarrayOpcional
documentsarrayOpcional

Respuestas

201 Respuesta HTTP

Solicitud creada y clasificada en las cuatro dimensiones de estado

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

application/json

errorobjectOpcional
403 Respuesta HTTP

Ámbito no habilitado para esta credencial

application/json

errorobjectOpcional
409 Respuesta HTTP

Conflicto de idempotencia (idempotency_key_payload_mismatch o idempotency_key_in_progress)

application/json

errorobjectOpcional
422 Respuesta HTTP

Error de validación de los campos de la solicitud

application/json

errorobjectOpcional
429 Respuesta HTTP

Límite de solicitudes excedido (limite_requisicoes). Espera el intervalo indicado en el encabezado Retry-After antes de reintentar. Puede provenir del proveedor o del límite antiabuso de FleetPay, calculado por empresa autenticada y grupo de rutas, con una ventana corta para ráfagas y otra larga para tráfico automatizado lento. Los límites son amplios deliberadamente: las integraciones reales, incluidos lotes grandes procesados de una vez, deberían quedar muy por debajo. Si tu integración alcanza un límite, contacta con FleetPay.

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "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"
}