← InícioFleetPay / API

Disparar rodada de distribuição de ofertas para os motoristas elegíveis da programação

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

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

Aciona DriverOfferRoundDistributionService::dispatchRoundForDemand na programação central de envio de ofertas (ShipperOfferSchedule / ShipperOperationalDemand), gerando ofertas reais (ShipperDriverOffer) destinadas aos motoristas que possuam simultaneamente:

  • Homologação ativa na carteira do Gestor (company_user.homologation_status = homologado);
  • Representação formal ativa pela empresa prestadora (driver_provider_representations.status = active com poderes operacionais e de recebimento/aceite);
  • Veículo ativo autorizado (driver_vehicle_authorizations.status = active);
  • Check-in diário de disponibilidade na data/base/turno do serviço (driver_availabilities.is_available = true).

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

idpath · stringObrigatório
Restrições
{
  "type": "string"
}

Corpo da Requisição

Opcional

application/json

expires_in_minutesintegerOpcional
minimum5
maximum1440

Respostas

200 Resposta HTTP

Rodada de ofertas disparada com ofertas criadas em shipper_driver_offers

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
403 Resposta HTTP

Ator autenticado não é o Gestor de Transporte responsável pela operação

application/json

errorobjectOpcional
404 Resposta HTTP

Solicitação não encontrada

application/json

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