---
title: "Create a delivery report from an external adapter (Shopify, WooCommerce, etc.) for observability"
method: POST
path: "/api/v1/transactions/{transactionId}/delivery-reports"
tags: ["Transactions"]
---

# Create a delivery report from an external adapter (Shopify, WooCommerce, etc.) for observability

`POST /api/v1/transactions/{transactionId}/delivery-reports`

## Request

- Base URL: `https://core.quidkey.com`
- URL: `https://core.quidkey.com/api/v1/transactions/{transactionId}/delivery-reports`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/banqzinc/apis/quidkey-api/docs/api/v1/transactions/:transactionId/delivery-reports/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a delivery report from an external adapter (Shopify, WooCommerce, etc.) for observability

## Path parameters

- `transactionId` string, required: The transaction number (not UUID)

## Request body

- DeliveryReportInput: Report from an external adapter about a finalization call to the external platform
  - `platform` string, required: Platform that performed the finalization
  - `finalization_type` string, required: Type of finalization performed
  - `external_reference` string: External platform reference ID (e.g., Shopify GID)
  - `request_payload` object: The payload sent to the external platform
  - `response` object: The response received from the external platform
  - `status` union, required: Whether the finalization call succeeded or failed
    - 'success'
    - 'failure'
  - `http_status` number: HTTP status code from the external platform
  - `duration_ms` number: How long the finalization call took in milliseconds
  - `payment_provider_status_id` string, uuid: Correlation ID linking to the PaymentProviderStatus that triggered this

## Response `200`

Success

- DeliveryReportResponse
  - `success` boolean, required
  - `data` object, required
    - `id` string, uuid, required
    - `message` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found

## Changes

- **2026-06-17** `b372e7d5563d`: 1 info
  - endpoint added
- **2025-11-02** `919eb7a392aa`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/banqzinc/apis/quidkey-api/changes/api/v1/transactions/:transactionId/delivery-reports/post.md)

---

[API](https://skmtc.dev/banqzinc/apis/quidkey-api.md) - [All operations](https://skmtc.dev/banqzinc/apis/quidkey-api/llms.txt) - [OpenAPI document](https://skmtc.dev/banqzinc/apis/quidkey-api/revisions/f86d2bdbcb08?raw)