← HomeFleetPay / API

Trigger offer distribution round to eligible schedule drivers

Parameters, data structure and responses from the versioned contract.

POST/embarcador/solicitacoes-transporte/{id}/disparar-rodada-ofertas
dispararRodadaOfertasSolicitacaoTransporteSandbox Base: https://api.fleetpay.site/v1

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

Triggers DriverOfferRoundDistributionService::dispatchRoundForDemand on the central offer dispatch schedule (ShipperOfferSchedule / ShipperOperationalDemand), generating real offers (ShipperDriverOffer) aimed at drivers who simultaneously hold:

  • Active vetting in the Manager's roster (company_user.homologation_status = homologado);
  • Active formal representation by the provider company (driver_provider_representations.status = active with operational and payment/acceptance authority);
  • Active authorized vehicle (driver_vehicle_authorizations.status = active);
  • Daily availability check-in for the service date/base/shift (driver_availabilities.is_available = true).

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"
}

Request Body

Optional

application/json

expires_in_minutesintegerOptional
minimum5
maximum1440

Responses

200 HTTP Response

Offer round triggered with offers created in shipper_driver_offers

application/json

successbooleanOptional
commercial_resolutionobject | nullOptional
403 HTTP Response

Authenticated actor is not the Transport Manager responsible for the operation

application/json

errorobjectOptional
404 HTTP Response

Request not found

application/json

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