← InicioFleetPay / API

Disparar ronda de distribución de ofertas para conductores elegibles de la programación

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

POST/embarcador/solicitacoes-transporte/{id}/disparar-rodada-ofertas
dispararRodadaOfertasSolicitacaoTransporteBase 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.

Acciona DriverOfferRoundDistributionService::dispatchRoundForDemand en la programación central de envío de ofertas (ShipperOfferSchedule / ShipperOperationalDemand), generando ofertas reales (ShipperDriverOffer) para conductores que cuenten simultáneamente con:

  • Homologación activa en la cartera del Gestor (company_user.homologation_status = homologado);
  • Representación formal activa por la empresa prestadora (driver_provider_representations.status = active con poderes operacionales y de cobro/aceptación);
  • Vehículo activo autorizado (driver_vehicle_authorizations.status = active);
  • Check-in diario de disponibilidad en la fecha/base/turno del servicio (driver_availabilities.is_available = true).

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

idpath · stringObligatorio
Restricciones
{
  "type": "string"
}

Cuerpo de la Solicitud

Opcional

application/json

expires_in_minutesintegerOpcional
minimum5
maximum1440

Respuestas

200 Respuesta HTTP

Ronda de ofertas disparada con ofertas creadas en shipper_driver_offers

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
403 Respuesta HTTP

El actor autenticado no es el Gestor de Transporte responsable de la operación

application/json

errorobjectOpcional
404 Respuesta HTTP

Solicitud no encontrada

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Disparar rodada de distribuição de ofertas para os motoristas elegíveis da programação",
  "description": "Aciona `DriverOfferRoundDistributionService::dispatchRoundForDemand` na programação central de envio de ofertas (`ShipperOfferSchedule` / `ShipperOperationalDemand`), gerando ofertas reais (`ShipperDriverOffer`) destinadas aos motoristas que possuam simultaneamente:\n- Homologação ativa na carteira do Gestor (`company_user.homologation_status = homologado`);\n- Representação formal ativa pela empresa prestadora (`driver_provider_representations.status = active` com poderes operacionais e de recebimento/aceite);\n- Veículo ativo autorizado (`driver_vehicle_authorizations.status = active`);\n- Check-in diário de disponibilidade na data/base/turno do serviço (`driver_availabilities.is_available = true`).\n",
  "operationId": "dispararRodadaOfertasSolicitacaoTransporte",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": false,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "expires_in_minutes": {
              "type": "integer",
              "minimum": 5,
              "maximum": 1440,
              "default": 120
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Rodada de ofertas disparada com ofertas criadas em `shipper_driver_offers`",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "403": {
      "description": "Ator autenticado não é o Gestor de Transporte responsável pela operação",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "404": {
      "description": "Solicitação não encontrada",
      "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": "POST",
  "path": "/embarcador/solicitacoes-transporte/{id}/disparar-rodada-ofertas"
}