Stream 4 — Return rate - Droplinked Developers

BETA. The return-rate stream projects refunded and cancelled orders from OrderV2 (status in REFUNDED, CANCELLED).

The return-rate stream emits the merchant’s refunded and cancelled orders. Compute the return rate client-side by comparing this stream’s volume against total order / sell-through volume. Rows are scoped to the shops owned by the API key’s merchant.

Endpoint

GET /v1/api/inventory-os/streams/return-rate

Query parameters:

Param	Type	Notes
`limit`	int	1–200, default 50
`cursor`	string	Opaque pagination token
`since`	ISO-8601	Optional; orders updated on or after this timestamp

Row shape

{
  "id": "665ford123…",
  "orderNumber": "DRP-100245",
  "shopId": "65df8abc123…",
  "status": "REFUNDED",
  "orderDate": "2026-05-28T09:14:00.000Z",
  "updatedAt": "2026-06-01T12:00:00.000Z"
}

Field	Meaning
`id`	`OrderV2` id; pagination cursor advances on this field
`orderNumber`	Human-readable order number
`status`	`REFUNDED` or `CANCELLED`
`orderDate`	When the order was originally placed

Response envelope

{
  "streamType": "return-rate",
  "merchantId": "65df8abc123…",
  "data": [ /* rows */ ],
  "count": 50,
  "nextCursor": "NjY1Zm9yZDEyMw..."
}

curl

curl "https://apiv3.droplinked.com/v1/api/inventory-os/streams/return-rate?limit=200" \
  -H "x-droplinked-api-key: REPLACE_ME"

Lender-facing usage

Combined with Stream 3 (sell-through), the underwriter derives the net-revenue forecast and an LGD input. The return-rate stream isolates the refund/cancel numerator so a working-capital line can be priced against it.

Rate limits

Mid-budget class — 500 reads/min/key, up to 5 subscriptions/key.

Sell-through stream — sale events per merchant
Settlement stream — order payment + financial detail
Webhook subscriptions — return-rate.changed events

Get Started

InventoryOS API

Lending Application API

KYB & Cohorts

Stream 4 — Return rate

Endpoint

Row shape

Response envelope

curl

Lender-facing usage

Rate limits

​Endpoint

​Row shape

​Response envelope

​curl

​Lender-facing usage

​Rate limits

​Related

Endpoint

Row shape

Response envelope

curl

Lender-facing usage

Rate limits

Related