← InicioFleetPay / API

Confirmar finalización/baja operativa de la entrega vía API

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

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

Registra la confirmación de finalización de ruta/entrega por el Embarcador o Gestor de Transporte autorizado (o por integración/proxy de TMS/enrutador), sin exigir foto de comprobante ni escaneo en la app del conductor cuando opera con require_driver_app = false.

  • Acepta en {id} ID numérico, uuid o referencia externa (external_reference / route_id).
  • Exige commercial_status = contracted (422 DELIVERY_CONFIRMATION_FAILED).
  • Actualiza la solicitud a attendance_status = completed, marca operaciones vinculadas (ShipperManagedOperation) como concluidas (operational_status = completed, status = completed, completando completed_at, executed_at y contractual_due_date), cierra vacantes (ShipperOperationalVacancy::STATUS_COMPLETED) y habilita el cierre diario consolidado de NFS-e (ConsolidatedDailyNfseClosingService).
  • Nota de integración TMS (ej.: Abbiamo): Cuando el embarcador usa enrutador integrado vía proxy de webhook (como POST /api/v1/integration/abbiamo/webhook al recibir ROUTE_STATUS_CHANGE con status = FINISHED), el proxy inyecta el documento en la API FleetPay (DocumentProcessingService) ejecutando automáticamente esta conciliación en FleetPay 2.0.

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

ID interno, UUID o external_reference (route_id) de la solicitud de transporte.

Restricciones
{
  "type": "string"
}
Idempotency-Keyheader · stringOpcional

Clave de idempotencia opcional para garantizar la ejecución única de la confirmación de entrega.

Restricciones
{
  "type": "string"
}

Cuerpo de la Solicitud

Opcional

application/json

completed_atstring | null · date-timeOpcional

Fecha/hora ISO-8601 de finalización de la entrega/ruta (predeterminado now()). Acepta también el alias delivered_at.

delivered_atstring | null · date-timeOpcional

Alias opcional para completed_at.

receiver_namestring | nullOpcional

Nombre del receptor (opcional).

receiver_documentstring | nullOpcional

CPF/CNPJ o documento del receptor (opcional).

notesstring | nullOpcional

Observaciones de confirmación operacional o referencia del TMS/enrutador (opcional).

pay_document_idinteger | nullOpcional

ID del documento financiero (pay_documents.id) vinculado cuando se concilia vía API de documentos o proxy de webhook.

external_service_idstring | nullOpcional

Identificador externo de la ruta/servicio en el TMS o enrutador (ej.: route_id de Abbiamo).

Respuestas

200 Respuesta HTTP

Entrega confirmada vía API (attendance_status = completed y ShipperManagedOperation concluida)

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
403 Respuesta HTTP

Empresa autenticada sin vínculo autorizado con el Embarcador o Gestor de la solicitud

application/json

errorobjectOpcional
404 Respuesta HTTP

Solicitud de transporte no encontrada

application/json

errorobjectOpcional
409 Respuesta HTTP

Repetición con la misma Idempotency-Key y payload divergente (idempotency_key_payload_mismatch)

application/json

errorobjectOpcional
422 Respuesta HTTP

Solicitud aún no contratada comercialmente (DELIVERY_CONFIRMATION_FAILED)

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Confirmar conclusão/baixa operacional da entrega via API",
  "description": "Registra a confirmação de conclusão da rota/entrega pelo Embarcador ou Gestor de Transporte autorizado (ou por integração/proxy de TMS/roteirizador), sem exigir foto de canhoto ou bipagem no aplicativo do motorista quando o embarcador opera com `require_driver_app = false`.\n- Aceita na rota `{id}` o ID numérico da solicitação, seu `uuid` ou sua referência externa (`external_reference` / `route_id`).\n- Exige que a solicitação esteja com `commercial_status = contracted` (`422 DELIVERY_CONFIRMATION_FAILED`).\n- Atualiza a solicitação para `attendance_status = completed`, marca as operações geridas vinculadas (`ShipperManagedOperation`) como concluídas (`operational_status = completed`, `status = completed`, preenchendo `completed_at`, `executed_at` e `contractual_due_date`), encerra as vagas operacionais (`ShipperOperationalVacancy::STATUS_COMPLETED`) e habilita a operação para o fechamento fiscal diário consolidado de NFS-e (`ConsolidatedDailyNfseClosingService`).\n- **Nota de integração TMS (ex.: Abbiamo):** Quando o embarcador utiliza um roteirizador integrado via proxy de webhook (como `POST /api/v1/integration/abbiamo/webhook` ao receber `ROUTE_STATUS_CHANGE` com `status = FINISHED`), o proxy injeta o documento concluído na API FleetPay (`DocumentProcessingService`), que executa automaticamente esta mesma conciliação e baixa no FleetPay 2.0 sem exigir chamada extra do embarcador.\n",
  "operationId": "confirmarEntregaSolicitacaoTransporte",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "ID interno, UUID ou `external_reference` (`route_id`) da solicitação de transporte.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "Idempotency-Key",
      "in": "header",
      "required": false,
      "description": "Chave de idempotência opcional para garantir execução única da confirmação de entrega.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": false,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ConfirmarEntregaSolicitacaoTransporteRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Entrega confirmada via API (`attendance_status = completed` e `ShipperManagedOperation` concluída)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "403": {
      "description": "Empresa autenticada sem vínculo autorizado com o Embarcador ou Gestor da solicitação",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "404": {
      "description": "Solicitação de transporte não encontrada",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "409": {
      "description": "Replay com mesma `Idempotency-Key` e payload divergente (`idempotency_key_payload_mismatch`)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Solicitação ainda não contratada comercialmente (`DELIVERY_CONFIRMATION_FAILED`)",
      "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-entrega"
}