---
title: "List settlements"
method: GET
path: "/ecommerce/settlements"
tags: ["Ecommerce — Money"]
---

# List settlements

`GET /ecommerce/settlements`

## Request

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

Per-cycle settlement summaries across channels (gross, fees, tax withheld, net settled, variance). Money is paise integers. Requires scope `ecommerce:money:read`.

## Query parameters

- `since` string, date-time
- `until` string, date-time
- `channels` string
- `storeIds` string
- `limit` integer
- `offset` integer

## Response `200`

A page of settlements.

- SettlementList
  - `items` UnifiedSettlement[]
    - `settlementId` string
    - `channelCode` string
    - `storeId` string
    - `periodStart` string, date-time
    - `periodEnd` string, date-time
    - `paidOn` string, date-time, nullable
    - `utr` string, nullable
    - `state` string
    - `grossSalesMinor` integer
    - `returnsMinor` integer
    - `feesMinor` integer
    - `taxWithheldMinor` integer
    - `adjustmentsMinor` integer
    - `netSettledMinor` integer
    - `varianceMinor` integer, nullable
    - `currencyCode` string
  - `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)