---
title: "List returns"
method: GET
path: "/ecommerce/returns"
tags: ["Ecommerce — Returns"]
---

# List returns

`GET /ecommerce/returns`

## Request

- Base URL: `https://app.zobrx.com/api/v1`
- URL: `https://app.zobrx.com/api/v1/ecommerce/returns`
- Auth: HTTP bearer

Unified multi-channel returns with claim-eligibility + reimbursement tracking. Money is paise integers. Buyer PII redacted unless the key holds `ecommerce:pii:read`. Requires scope `ecommerce:returns:read`.

## Query parameters

- `since` string, date-time
- `until` string, date-time
- `dateType` 'order' | 'return'
- `channels` string
- `storeIds` string
- `bucket` string
- `received` 'true' | 'false'
- `search` string
- `limit` integer
- `offset` integer

## Response `200`

A page of returns.

- ReturnList
  - `items` UnifiedReturn[]
    - `returnId` string
    - `orderId` string, nullable
    - `lineItemId` string
    - `channelCode` string
    - `storeId` string
    - `sku` string
    - `productName` string
    - `qty` integer
    - `refundAmountMinor` integer, nullable
    - `feeReversedMinor` integer, nullable
    - `reimbursementReceivedMinor` integer, nullable
    - `state` string
    - `bucket` string
    - `returnReason` string, nullable
    - `claim` object
    - `returnInitiatedOn` string, date-time, nullable
    - `received` boolean
    - `channelSpecific` object
  - `pagination` ListPagination
    - `total` integer
    - `limit` integer
    - `offset` integer
    - `hasMore` boolean
  - `perChannelCount` object

## Other responses

- `401`: Missing/invalid API key.
- `403`: The API key is missing the scope this endpoint requires.

---

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