---
title: "Reads commission totals over a period."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › affiliate

`GET /v1/stores/{store}/commissions/stats`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `affiliate:read`

## Path parameters

- `store` (`commissionStats.path.store`; string, required) — The store's id.

## Query parameters

- `from` (`commissionStats.query.from`; string, optional)
  - format `date`
- `to` (`commissionStats.query.to`; string, optional)
  - format `date`
- `bucket` (`commissionStats.query.bucket`; string, optional)
  - one of `"day"`, `"week"`, `"month"`
- `user` (`commissionStats.query.user`; string, optional) — An id.
  - minLength 1
- `discount` (`commissionStats.query.discount`; string, optional) — An id.
  - minLength 1

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/commissions/stats' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/commissions/stats';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/commissions/stats"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads commission totals over a period.

#### Example

```json
{
  "currencies": [
    {
      "currency": "string",
      "exponent": 0,
      "earned": 0,
      "unpaid": 0,
      "paid": 0,
      "voided": 0,
      "commissions": 0,
      "range_earned": {
        "current": 0,
        "previous": 0
      },
      "range_commissions": {
        "current": 0,
        "previous": 0
      },
      "series": [
        {
          "start": "string",
          "end": "string",
          "earned": 0,
          "commissions": 0,
          "previous_earned": 0,
          "previous_commissions": 0
        }
      ]
    }
  ],
  "bucket": "string",
  "time_zone": "string",
  "from": "string",
  "to": "string",
  "previous_range": {
    "from": "string",
    "to": "string"
  }
}
```

- `currencies` (`commissionStats.response.200.currencies`; array<object>, required)
  - `currency` (`commissionStats.response.200.currencies.currency`; string, required)
  - `exponent` (`commissionStats.response.200.currencies.exponent`; any of, required)
    - any of: `number`, `null`
  - `earned` (`commissionStats.response.200.currencies.earned`; any of, required)
    - any of: `number`, `null`
  - `unpaid` (`commissionStats.response.200.currencies.unpaid`; any of, required)
    - any of: `number`, `null`
  - `paid` (`commissionStats.response.200.currencies.paid`; any of, required)
    - any of: `number`, `null`
  - `voided` (`commissionStats.response.200.currencies.voided`; any of, required)
    - any of: `number`, `null`
  - `commissions` (`commissionStats.response.200.currencies.commissions`; number, required)
  - `range_earned` (`commissionStats.response.200.currencies.range_earned`; any of, required)
    - any of: `object`, `null`
  - `range_commissions` (`commissionStats.response.200.currencies.range_commissions`; object, required)
    - `current` (`commissionStats.response.200.currencies.range_commissions.current`; number, required)
    - `previous` (`commissionStats.response.200.currencies.range_commissions.previous`; number, required)
  - `series` (`commissionStats.response.200.currencies.series`; array<object>, required)
    - `start` (`commissionStats.response.200.currencies.series.start`; string, required)
    - `end` (`commissionStats.response.200.currencies.series.end`; string, required)
    - `earned` (`commissionStats.response.200.currencies.series.earned`; any of, required)
      - any of: `number`, `null`
    - `commissions` (`commissionStats.response.200.currencies.series.commissions`; number, required)
    - `previous_earned` (`commissionStats.response.200.currencies.series.previous_earned`; any of, required)
      - any of: `number`, `null`
    - `previous_commissions` (`commissionStats.response.200.currencies.series.previous_commissions`; number, required)
- `bucket` (`commissionStats.response.200.bucket`; string, required)
- `time_zone` (`commissionStats.response.200.time_zone`; string, required)
- `from` (`commissionStats.response.200.from`; string, required)
- `to` (`commissionStats.response.200.to`; string, required)
- `previous_range` (`commissionStats.response.200.previous_range`; object, required)
  - `from` (`commissionStats.response.200.previous_range.from`; string, required)
  - `to` (`commissionStats.response.200.previous_range.to`; string, required)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`commissionStats.response.default.type`; string, required)
  - format `uri`
- `title` (`commissionStats.response.default.title`; string, required)
- `status` (`commissionStats.response.default.status`; integer, required)
- `detail` (`commissionStats.response.default.detail`; string, required)
- `code` (`commissionStats.response.default.code`; string, optional)
- `context` (`commissionStats.response.default.context`; object, optional)
- `reached_core` (`commissionStats.response.default.reached_core`; boolean, optional)
- `core_answer` (`commissionStats.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/commission-stats/index.md
