← InícioFleetPay / API

Confirmar conclusão/baixa operacional da entrega via API

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

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

  • Aceita na rota {id} o ID numérico da solicitação, seu uuid ou sua referência externa (external_reference / route_id).
  • Exige que a solicitação esteja com commercial_status = contracted (422 DELIVERY_CONFIRMATION_FAILED).
  • 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).
  • 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.

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

ID interno, UUID ou external_reference (route_id) da solicitação de transporte.

Restrições
{
  "type": "string"
}
Idempotency-Keyheader · stringOpcional

Chave de idempotência opcional para garantir execução única da confirmação de entrega.

Restrições
{
  "type": "string"
}

Corpo da Requisição

Opcional

application/json

completed_atstring | null · date-timeOpcional

Data/hora ISO-8601 da conclusão da entrega/rota (default now()). Aceita também o alias delivered_at.

delivered_atstring | null · date-timeOpcional

Alias opcional para completed_at.

receiver_namestring | nullOpcional

Nome do recebedor (opcional).

receiver_documentstring | nullOpcional

CPF/CNPJ ou documento do recebedor (opcional).

notesstring | nullOpcional

Observações da confirmação operacional ou referência do TMS/roteirizador (opcional).

pay_document_idinteger | nullOpcional

ID do documento financeiro (pay_documents.id) vinculado quando conciliado via API de documentos ou proxy de webhook.

external_service_idstring | nullOpcional

Identificador externo da rota/serviço no TMS ou roteirizador (ex.: route_id da Abbiamo).

Respostas

200 Resposta HTTP

Entrega confirmada via API (attendance_status = completed e ShipperManagedOperation concluída)

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
403 Resposta HTTP

Empresa autenticada sem vínculo autorizado com o Embarcador ou Gestor da solicitação

application/json

errorobjectOpcional
404 Resposta HTTP

Solicitação de transporte não encontrada

application/json

errorobjectOpcional
409 Resposta HTTP

Replay com mesma Idempotency-Key e payload divergente (idempotency_key_payload_mismatch)

application/json

errorobjectOpcional
422 Resposta HTTP

Solicitação ainda não contratada comercialmente (DELIVERY_CONFIRMATION_FAILED)

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "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"
}