idpath · stringRequiredInternal ID, UUID or external_reference (route_id) of the transport request.
Constraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/embarcador/solicitacoes-transporte/{id}/confirmar-entregaTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Records confirmation of route/delivery completion by the authorized Shipper or Transport Manager (or via TMS/router webhook proxy), without requiring proof-of-delivery photo or driver app scanning when the shipper runs with require_driver_app = false.
uuid or external reference (external_reference / route_id) in {id}.commercial_status = contracted (422 DELIVERY_CONFIRMATION_FAILED).attendance_status = completed, marks linked ShipperManagedOperation rows completed (operational_status = completed, status = completed, setting completed_at, executed_at and contractual_due_date), closes ShipperOperationalVacancy::STATUS_COMPLETED and enables the operation for consolidated daily NFS-e closing (ConsolidatedDailyNfseClosingService).POST /api/v1/integration/abbiamo/webhook receiving ROUTE_STATUS_CHANGE with status = FINISHED), the proxy injects the completed document into FleetPay's API (DocumentProcessingService), automatically performing this same reconciliation and settlement release in FleetPay 2.0 without requiring an extra shipper call.operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]idpath · stringRequiredInternal ID, UUID or external_reference (route_id) of the transport request.
{
"type": "string"
}Idempotency-Keyheader · stringOptionalOptional idempotency key to ensure single execution of delivery confirmation.
{
"type": "string"
}Optional
application/jsoncompleted_atstring | null · date-timeOptionalISO-8601 timestamp of delivery/route completion (default now()). Also accepts alias delivered_at.
delivered_atstring | null · date-timeOptionalOptional alias for completed_at.
receiver_namestring | nullOptionalRecipient name (optional).
receiver_documentstring | nullOptionalRecipient CPF/CNPJ or ID document (optional).
notesstring | nullOptionalOperational confirmation notes or TMS/router reference (optional).
pay_document_idinteger | nullOptionalLinked financial document ID (pay_documents.id) when reconciled via the Documents API or webhook proxy.
external_service_idstring | nullOptionalExternal route/service identifier in the TMS or router (e.g. route_id from Abbiamo).
200 HTTP ResponseDelivery confirmed via API (attendance_status = completed and ShipperManagedOperation completed)
application/jsonsuccessbooleanOptionaldataobjectOptionalcommercial_resolutionobject | nullOptional403 HTTP ResponseAuthenticated company has no authorized link with the request Shipper or Manager
409 HTTP ResponseReplay with the same Idempotency-Key and diverging payload (idempotency_key_payload_mismatch)
422 HTTP ResponseRequest not yet commercially contracted (DELIVERY_CONFIRMATION_FAILED)
{
"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"
}