← InícioFleetPay / API

Registrar compromisso comercial do gestor ou confirmar alocação de executor com aceite individual

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

POST/embarcador/solicitacoes-transporte/{id}/confirmar-atendimento
confirmarAtendimentoSolicitacaoTransporteBase 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.

Separa o compromisso comercial de atendimento assumido pelo Gestor de Transporte (commitment_scope: manager_commitment, atualizando attendance_status para manager_committed) da alocação/confirmação de executor individual (commitment_scope: executor_allocation, atualizando attendance_status para partially_confirmed ou confirmed conforme o preenchimento de vagas).

  • Compromisso comercial do gestor (manager_commitment): registra que o Gestor de Transporte assumiu o compromisso de atender a demanda contratada, sem fingir que um motorista específico já aceitou a oferta. Se um CNPJ prestador (aggregated_carrier_company_id) for informado sem driver_user_id, é validado e registrado como prestador indicado/vinculado, mantendo o estado em manager_committed.
  • Alocação/confirmação de executor (executor_allocation): exige aggregated_carrier_company_id elegível + driver_user_id homologado no gestor + evidência canônica de aceite explícito da oferta pelo motorista autorizado (POST /embarcador/solicitacoes-transporte/{id}/aceitar-oferta-motorista) compatível com a versão de condições vigentes (conditions_version).
  • Credencial do gestor ou da API não aceita pelo agregado (422 MANAGER_CANNOT_ACCEPT_FOR_DRIVER).
  • Check-in diário (driver_availabilities) apenas declara disponibilidade para aquela data operacional (service_date); não equivale a aceite de oferta (422 DAILY_CHECKIN_DOES_NOT_EQUAL_ACCEPTANCE) e não se propaga automaticamente para outro dia (422 DAILY_CHECKIN_DATE_MISMATCH).
  • Múltiplos motoristas do mesmo CNPJ prestador: preserva a distinção entre empresa prestadora contratada (aggregated_carrier_company_id / CNPJ), motorista (driver_user_id / CPF), veículo (vehicle_id / vehicle_plate / vehicle_type) e representação autorizada, limitando a quantidade de executores confirmados ao teto de vagas da programação (422 VACANCY_LIMIT_EXCEEDED).

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

commitment_scopestring | nullOpcional

Escopo da ação (manager_commitment para compromisso comercial do gestor; executor_allocation para confirmar motorista com aceite explícito).

"manager_commitment" · "executor_allocation" · null
aggregated_carrier_company_idinteger | nullOpcional

ID da empresa prestadora (Transportador Agregado / CNPJ) elegível vinculada ao Gestor de Transporte responsável. Obrigatório em executor_allocation.

driver_user_idinteger | nullOpcional

ID do motorista autorizado (users.id) que aceitou explicitamente a oferta. Obrigatório para confirmar executor (confirmed / partially_confirmed).

vehicle_idinteger | nullOpcional
vehicle_platestring | nullOpcional
vehicle_typestring | nullOpcional
work_unit_keystring | nullOpcional

Identificador da unidade de trabalho (diária/turno) para evitar geração de diária duplicada quando novas entregas são incorporadas ao mesmo turno aceito.

Respostas

200 Resposta HTTP

Compromisso do gestor registrado (manager_committed) ou executor confirmado (partially_confirmed / confirmed)

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
403 Resposta HTTP

Tentativa de autorização por slug/marca White Label ou ator sem vínculo autorizado

application/json

errorobjectOpcional
404 Resposta HTTP

Solicitação não encontrada

application/json

errorobjectOpcional
422 Resposta HTTP

Solicitação não contratada, tentativa do gestor de aceitar pelo motorista (MANAGER_CANNOT_ACCEPT_FOR_DRIVER), check-in diário sem aceite de oferta (DAILY_CHECKIN_DOES_NOT_EQUAL_ACCEPTANCE), check-in de outro dia (DAILY_CHECKIN_DATE_MISMATCH), ausência de aceite canônico (DRIVER_OFFER_ACCEPTANCE_REQUIRED) ou limite de vagas excedido (VACANCY_LIMIT_EXCEEDED)

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Registrar compromisso comercial do gestor ou confirmar alocação de executor com aceite individual",
  "description": "Separa o **compromisso comercial de atendimento assumido pelo Gestor de Transporte** (`commitment_scope: manager_commitment`, atualizando `attendance_status` para `manager_committed`) da **alocação/confirmação de executor individual** (`commitment_scope: executor_allocation`, atualizando `attendance_status` para `partially_confirmed` ou `confirmed` conforme o preenchimento de vagas).\n\n- **Compromisso comercial do gestor (`manager_commitment`)**: registra que o Gestor de Transporte assumiu o compromisso de atender a demanda contratada, sem fingir que um motorista específico já aceitou a oferta. Se um CNPJ prestador (`aggregated_carrier_company_id`) for informado sem `driver_user_id`, é validado e registrado como prestador indicado/vinculado, mantendo o estado em `manager_committed`.\n- **Alocação/confirmação de executor (`executor_allocation`)**: exige `aggregated_carrier_company_id` elegível + `driver_user_id` homologado no gestor + **evidência canônica de aceite explícito da oferta pelo motorista autorizado** (`POST /embarcador/solicitacoes-transporte/{id}/aceitar-oferta-motorista`) compatível com a versão de condições vigentes (`conditions_version`).\n- **Credencial do gestor ou da API não aceita pelo agregado** (`422 MANAGER_CANNOT_ACCEPT_FOR_DRIVER`).\n- **Check-in diário (`driver_availabilities`) apenas declara disponibilidade** para aquela data operacional (`service_date`); não equivale a aceite de oferta (`422 DAILY_CHECKIN_DOES_NOT_EQUAL_ACCEPTANCE`) e não se propaga automaticamente para outro dia (`422 DAILY_CHECKIN_DATE_MISMATCH`).\n- **Múltiplos motoristas do mesmo CNPJ prestador**: preserva a distinção entre empresa prestadora contratada (`aggregated_carrier_company_id` / CNPJ), motorista (`driver_user_id` / CPF), veículo (`vehicle_id` / `vehicle_plate` / `vehicle_type`) e representação autorizada, limitando a quantidade de executores confirmados ao teto de vagas da programação (`422 VACANCY_LIMIT_EXCEEDED`).\n",
  "operationId": "confirmarAtendimentoSolicitacaoTransporte",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "commitment_scope": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "manager_commitment",
                "executor_allocation",
                null
              ],
              "description": "Escopo da ação (`manager_commitment` para compromisso comercial do gestor; `executor_allocation` para confirmar motorista com aceite explícito)."
            },
            "aggregated_carrier_company_id": {
              "type": [
                "integer",
                "null"
              ],
              "description": "ID da empresa prestadora (Transportador Agregado / CNPJ) elegível vinculada ao Gestor de Transporte responsável. Obrigatório em `executor_allocation`."
            },
            "driver_user_id": {
              "type": [
                "integer",
                "null"
              ],
              "description": "ID do motorista autorizado (`users.id`) que aceitou explicitamente a oferta. Obrigatório para confirmar executor (`confirmed` / `partially_confirmed`)."
            },
            "vehicle_id": {
              "type": [
                "integer",
                "null"
              ]
            },
            "vehicle_plate": {
              "type": [
                "string",
                "null"
              ]
            },
            "vehicle_type": {
              "type": [
                "string",
                "null"
              ]
            },
            "work_unit_key": {
              "type": [
                "string",
                "null"
              ],
              "description": "Identificador da unidade de trabalho (diária/turno) para evitar geração de diária duplicada quando novas entregas são incorporadas ao mesmo turno aceito."
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Compromisso do gestor registrado (`manager_committed`) ou executor confirmado (`partially_confirmed` / `confirmed`)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "403": {
      "description": "Tentativa de autorização por slug/marca White Label ou ator sem vínculo autorizado",
      "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": "Solicitação não contratada, tentativa do gestor de aceitar pelo motorista (`MANAGER_CANNOT_ACCEPT_FOR_DRIVER`), check-in diário sem aceite de oferta (`DAILY_CHECKIN_DOES_NOT_EQUAL_ACCEPTANCE`), check-in de outro dia (`DAILY_CHECKIN_DATE_MISMATCH`), ausência de aceite canônico (`DRIVER_OFFER_ACCEPTANCE_REQUIRED`) ou limite de vagas excedido (`VACANCY_LIMIT_EXCEEDED`)",
      "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}/confirmar-atendimento"
}