← InícioFleetPay / API

Registrar aceite explícito da oferta de transporte pelo motorista autorizado

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

POST/embarcador/solicitacoes-transporte/{id}/aceitar-oferta-motorista
aceitarOfertaMotoristaSolicitacaoTransporteBase 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 o aceite explícito da oferta real (ShipperDriverOffer emitida e pendente na rodada ativa) pelo motorista destinatário autorizado (driver_user_id), delegando à autoridade central DriverOfferRoundDistributionService::acceptOfferByDriver.

  • Exige offer_id obrigatório (OFFER_ID_REQUIRED) referenciando uma oferta real existente (OFFER_NOT_FOUND), já enviada (OFFER_NOT_DISPATCHED), não retirada (OFFER_WITHDRAWN), dentro do prazo (OFFER_EXPIRED) e destinada ao motorista autenticado (OFFER_RECIPIENT_MISMATCH).
  • Exige conditions_version explícita (OFFER_CONDITIONS_VERSION_REQUIRED) idêntica aos termos apresentados na oferta e vigentes na demanda (OFFER_CONDITIONS_VERSION_MISMATCH).
  • Valida representação formal ativa (DriverProviderRepresentation / DriverRepresentationService), veículo autorizado (DriverVehicleAuthorization), check-in diário na data do serviço (DriverAvailability) e disponibilidade da vaga (VACANCY_ALREADY_FILLED).

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

Obrigatório

application/json

offer_idintegerObrigatório

ID obrigatório da oferta real (shipper_driver_offers.id) emitida e pendente para o motorista autenticado.

conditions_versionintegerObrigatório

Versão obrigatória das condições apresentadas na oferta e vigentes na demanda (OFFER_CONDITIONS_VERSION_REQUIRED).

driver_user_idinteger | nullOpcional

ID do motorista autenticado (users.id). Deve coincidir com o usuário autenticado e destinatário da oferta (OFFER_RECIPIENT_MISMATCH).

aggregated_carrier_company_idintegerObrigatório

ID da empresa prestadora (companies.id / CNPJ) formalmente representada pelo motorista em driver_provider_representations.

driver_representation_idinteger | nullOpcional

ID da representação formal ativa (driver_provider_representations.id).

vehicle_idinteger | nullOpcional

ID do veículo autorizado para o motorista em driver_vehicle_authorizations.

vacancy_slot_numberinteger | nullOpcional

Número da vaga operacional (shipper_operational_vacancies.slot_number).

work_unit_keystring | nullOpcional

Chave da diária/turno operacional.

Respostas

200 Resposta HTTP

Aceite explícito do motorista registrado em shipper_driver_offers e shipper_operational_vacancies

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
403 Resposta HTTP

Ator autenticado não corresponde ao motorista destinatário (OFFER_RECIPIENT_MISMATCH) ou não possui representação formal ativa (DRIVER_REPRESENTATION_REQUIRED)

application/json

errorobjectOpcional
404 Resposta HTTP

Solicitação não encontrada

application/json

errorobjectOpcional
422 Resposta HTTP

Oferta ausente (OFFER_ID_REQUIRED), inexistente (OFFER_NOT_FOUND), não enviada (OFFER_NOT_DISPATCHED), retirada (OFFER_WITHDRAWN), expirada (OFFER_EXPIRED), versão de condições omitida (OFFER_CONDITIONS_VERSION_REQUIRED) ou divergente (OFFER_CONDITIONS_VERSION_MISMATCH), vaga já preenchida (VACANCY_ALREADY_FILLED) ou check-in diário ausente/de outra data (DAILY_CHECKIN_DATE_MISMATCH)

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Registrar aceite explícito da oferta de transporte pelo motorista autorizado",
  "description": "Registra o aceite explícito da oferta real (`ShipperDriverOffer` emitida e pendente na rodada ativa) pelo motorista destinatário autorizado (`driver_user_id`), delegando à autoridade central `DriverOfferRoundDistributionService::acceptOfferByDriver`.\n- Exige `offer_id` obrigatório (`OFFER_ID_REQUIRED`) referenciando uma oferta real existente (`OFFER_NOT_FOUND`), já enviada (`OFFER_NOT_DISPATCHED`), não retirada (`OFFER_WITHDRAWN`), dentro do prazo (`OFFER_EXPIRED`) e destinada ao motorista autenticado (`OFFER_RECIPIENT_MISMATCH`).\n- Exige `conditions_version` explícita (`OFFER_CONDITIONS_VERSION_REQUIRED`) idêntica aos termos apresentados na oferta e vigentes na demanda (`OFFER_CONDITIONS_VERSION_MISMATCH`).\n- Valida representação formal ativa (`DriverProviderRepresentation` / `DriverRepresentationService`), veículo autorizado (`DriverVehicleAuthorization`), check-in diário na data do serviço (`DriverAvailability`) e disponibilidade da vaga (`VACANCY_ALREADY_FILLED`).\n",
  "operationId": "aceitarOfertaMotoristaSolicitacaoTransporte",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AceitarOfertaMotoristaRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Aceite explícito do motorista registrado em `shipper_driver_offers` e `shipper_operational_vacancies`",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "403": {
      "description": "Ator autenticado não corresponde ao motorista destinatário (`OFFER_RECIPIENT_MISMATCH`) ou não possui representação formal ativa (`DRIVER_REPRESENTATION_REQUIRED`)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "404": {
      "description": "Solicitação não encontrada",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Oferta ausente (`OFFER_ID_REQUIRED`), inexistente (`OFFER_NOT_FOUND`), não enviada (`OFFER_NOT_DISPATCHED`), retirada (`OFFER_WITHDRAWN`), expirada (`OFFER_EXPIRED`), versão de condições omitida (`OFFER_CONDITIONS_VERSION_REQUIRED`) ou divergente (`OFFER_CONDITIONS_VERSION_MISMATCH`), vaga já preenchida (`VACANCY_ALREADY_FILLED`) ou check-in diário ausente/de outra data (`DAILY_CHECKIN_DATE_MISMATCH`)",
      "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}/aceitar-oferta-motorista"
}