← InicioFleetPay / API

Registrar compromiso comercial del gestor o confirmar asignación de ejecutor con aceptación individual

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

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

Separa el compromiso comercial de atención asumido por el Gestor de Transporte (commitment_scope: manager_commitment, actualizando attendance_status a manager_committed) de la asignación/confirmación de ejecutor individual (commitment_scope: executor_allocation, actualizando attendance_status a partially_confirmed o confirmed según vacantes cubiertas).

  • Compromiso comercial del gestor (manager_commitment): registra que el Gestor asumió el compromiso sin simular que un conductor aceptó la oferta. Si se informa aggregated_carrier_company_id sin driver_user_id, queda como prestador indicado/vinculado en manager_committed.
  • Asignación/confirmación de ejecutor (executor_allocation): exige aggregated_carrier_company_id elegible + driver_user_id homologado + evidencia canónica de aceptación explícita de la oferta por el conductor autorizado (POST /embarcador/solicitacoes-transporte/{id}/aceitar-oferta-motorista) compatible con conditions_version.
  • Credencial del gestor o de la API no acepta por el agregado (422 MANAGER_CANNOT_ACCEPT_FOR_DRIVER).
  • Check-in diario (driver_availabilities) solo declara disponibilidad en esa fecha (service_date); no equivale a aceptar oferta (422 DAILY_CHECKIN_DOES_NOT_EQUAL_ACCEPTANCE) ni se propaga a otro día (422 DAILY_CHECKIN_DATE_MISMATCH).
  • Múltiples conductores del mismo CNPJ prestador: preserva la distinción entre empresa prestadora (aggregated_carrier_company_id), conductor (driver_user_id), vehículo (vehicle_id / vehicle_plate / vehicle_type) y representación autorizada, limitando ejecutores confirmados al tope de vacantes (422 VACANCY_LIMIT_EXCEEDED).

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

Obligatorio

application/json

commitment_scopestring | nullOpcional

Alcance de la acción (manager_commitment para compromiso comercial del gestor; executor_allocation para confirmar conductor con aceptación explícita).

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

ID de la empresa prestadora (Transportista Agregado / CNPJ) elegible vinculada al Gestor de Transporte responsable. Obligatorio en executor_allocation.

driver_user_idinteger | nullOpcional

ID del conductor autorizado (users.id) que aceptó explícitamente la oferta. Obligatorio para confirmar ejecutor (confirmed / partially_confirmed).

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

Identificador de la unidad de trabajo (jornada/turno) para evitar generar una tarifa diaria duplicada cuando se incorporan nuevas entregas al mismo turno aceptado.

Respuestas

200 Respuesta HTTP

Compromiso del gestor registrado (manager_committed) o ejecutor confirmado (partially_confirmed / confirmed)

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
403 Respuesta HTTP

Intento de autorización por slug/marca White Label o actor sin vínculo autorizado

application/json

errorobjectOpcional
404 Respuesta HTTP

Solicitud no encontrada

application/json

errorobjectOpcional
422 Respuesta HTTP

Solicitud no contratada, intento del gestor de aceptar por el conductor (MANAGER_CANNOT_ACCEPT_FOR_DRIVER), check-in diario sin aceptación de oferta (DAILY_CHECKIN_DOES_NOT_EQUAL_ACCEPTANCE), check-in de otro día (DAILY_CHECKIN_DATE_MISMATCH), falta de aceptación canónica (DRIVER_OFFER_ACCEPTANCE_REQUIRED) o límite de vacantes excedido (VACANCY_LIMIT_EXCEEDED)

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "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"
}