> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/ru/developers/api/reference/returns/list-returns.md).

# List sales returns

> Returns a cursor-paginated list of active sales returns.

Line items, tags, and receiving progress are available from the single-return endpoint.

`GET https://rest.boxhero-app.com/v1/returns`

## Авторизация

- `Authorization` (string, обязательный): Заголовок аутентификации Bearer в формате `Bearer <token>`, где `<token>` — ваш [API-токен](https://www.boxhero.io/docs/ru/developers/api/authentication).

## Параметры запроса

- `statuses` (string | array of string): Filter by one or more return statuses.
- `partner_id` (integer, minimum 0, maximum 2147483647): Filter by partner id.
- `return_number` (string): Filter by exact return number. Whitespace is ignored and letters are uppercased.
- `order_number` (string): Filter by exact source order number. Whitespace is ignored and letters are uppercased.
- `order_id` (integer, minimum 0, maximum 2147483647): Filter by source order id.
- `tags` (string | array of string): Filter by tags with all-match semantics.
- `returned_after` (string, date-time): Filter by return_time >= this timestamp.
- `returned_before` (string, date-time): Filter by return_time < this timestamp.
- `created_by_id` (integer, minimum 0, maximum 2147483647): Filter by creator member id.
- `cursor` (integer, minimum 0, maximum 2147483647): Page cursor. Pass the `cursor` field from the previous response to fetch the next page. Omit on the first call.
- `limit` (integer, minimum 1, maximum 100): Page size. Accepts `1`–`100`; defaults to `100`.

## Ответы

**200** A page of sales returns.

- `items` (array of SimpleReturn, обязательный): Items in this page. Default ordering is by id ascending; see the resource's list endpoint description for any per-resource overrides.

  - `id` (integer, minimum 0, maximum 2147483647, обязательный): Return id.
  - `return_number` (string, обязательный): Return number.
  - `return_time` (string, date-time, обязательный): Return date/time.
  - `status` (string, обязательный): Return status.

    Возможные значения: `confirmed`, `in-progress`, `done`
  - `partner` (Entity, nullable, обязательный): Customer for the sales return.

    - `id` (integer, minimum 0, maximum 2147483647, обязательный): Id of the referenced entity.
    - `name` (string, обязательный): Display name of the entity at the time the transaction was recorded.
    - `deleted` (boolean, обязательный): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
  - `order` (OrderRef, обязательный): Reference to the source sales order for a return.

    - `id` (integer, minimum 0, maximum 2147483647, обязательный): Order id.
    - `order_number` (string, обязательный): Order number.
  - `total_price` (string, обязательный): Return total as a decimal string.
  - `currency_code` (string, nullable, обязательный): Source sales order ISO currency code, or null when unset.
  - `memo` (string, обязательный): Free-text memo. Empty string when not set.
  - `revision` (integer, minimum -9007199254740991, maximum 9007199254740991, обязательный): Optimistic-concurrency version.
  - `created_by` (Entity, обязательный): Reference to a related entity (location, partner, or user) embedded in a transaction. The snapshot is captured at transaction time and does not update if the source entity is later renamed or removed.

    - `id` (integer, minimum 0, maximum 2147483647, обязательный): Id of the referenced entity.
    - `name` (string, обязательный): Display name of the entity at the time the transaction was recorded.
    - `deleted` (boolean, обязательный): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
  - `created_at` (string, date-time, обязательный): Server-side creation timestamp.
  - `url` (string, uri, обязательный): Web URL to view this return in the BoxHero app.
  - `count_of_items` (integer, minimum 0, maximum 9007199254740991, обязательный): Number of return lines.
  - `total_quantity` (number, обязательный): Sum of returned quantities. Bundle lines are exploded into component item quantities.
- `count` (integer, minimum 0, maximum 9007199254740991, обязательный): Number of items in this page (`items.length`).
- `limit` (integer, minimum 0, maximum 9007199254740991, обязательный): Page size used to build this response.
- `cursor` (integer, minimum 0, maximum 2147483647, nullable, обязательный): Cursor to pass as `cursor` in the next request. `null` when `has_more` is `false`.
- `has_more` (boolean, обязательный): True when another page is available. The cursor is monotonic — pass it as `cursor` on the next request to advance the page. Direction follows each resource's ordering (default: id ascending).

**401** Missing or invalid API token.

- `id` (string, обязательный): Unique exception id (`ex_` followed by 32 lowercase hex chars, no dashes — e.g. `ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a`). Quote this in support tickets so we can find the request in our logs.
- `type` (string, обязательный): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Возможные значения: `/errors/not-found`, `/errors/invalid-request`, `/errors/invalid-team-mode`, `/errors/tokens/invalid`, `/errors/tokens/required`, `/errors/too-many-requests`, `/errors/core/usage-limit-exceeded`, `/errors/core/forbidden`, `/errors/core/unhandled`, `/errors/unhandled`
- `title` (string, обязательный): Human-readable summary of the error, in English.
- `correlationID` (string, обязательный): Request correlation id (`rq_` followed by 32 lowercase hex chars, no dashes — e.g. `rq_01abf3...`). Identical to the `X-Correlation-Id` response header. Pass an `X-Correlation-Id` request header to thread your trace through to ours.
- `instance` (string, обязательный): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `code` (string): Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. `not-available-for-api-token` on 403). Use this for fine-grained branching after dispatching on `type`.
- `errors` (array of object): Field-level error details. Present on `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, обязательный)
  - `message` (string, обязательный)

**429** Rate limit exceeded. Check `RateLimit`, `Retry-After`, and `X-RateLimit-*` response headers before retrying.

- `id` (string, обязательный): Unique exception id (`ex_` followed by 32 lowercase hex chars, no dashes — e.g. `ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a`). Quote this in support tickets so we can find the request in our logs.
- `type` (string, обязательный): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Возможные значения: `/errors/not-found`, `/errors/invalid-request`, `/errors/invalid-team-mode`, `/errors/tokens/invalid`, `/errors/tokens/required`, `/errors/too-many-requests`, `/errors/core/usage-limit-exceeded`, `/errors/core/forbidden`, `/errors/core/unhandled`, `/errors/unhandled`
- `title` (string, обязательный): Human-readable summary of the error, in English.
- `correlationID` (string, обязательный): Request correlation id (`rq_` followed by 32 lowercase hex chars, no dashes — e.g. `rq_01abf3...`). Identical to the `X-Correlation-Id` response header. Pass an `X-Correlation-Id` request header to thread your trace through to ours.
- `instance` (string, обязательный): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `code` (string): Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. `not-available-for-api-token` on 403). Use this for fine-grained branching after dispatching on `type`.
- `errors` (array of object): Field-level error details. Present on `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, обязательный)
  - `message` (string, обязательный)

Запрос

**cURL**

```bash
curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/returns' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"
```

**JavaScript**

```javascript
const response = await fetch("https://rest.boxhero-app.com/v1/returns", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
  },
});
const data = await response.json();
```

**Python**

```python
import os
import requests

response = requests.get(
    "https://rest.boxhero-app.com/v1/returns",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()
```

**HTTP**

```http
GET /v1/returns HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
```

Ответ

**200**

```json
{
  "items": [
    {
      "id": 90301,
      "return_number": "R-1001",
      "return_time": "2026-01-15T09:30:00.000Z",
      "status": "confirmed",
      "partner": {
        "id": 431488,
        "name": "Northwind Retail",
        "deleted": false
      },
      "order": {
        "id": 90201,
        "order_number": "SO-2001"
      },
      "total_price": "99.95",
      "currency_code": "USD",
      "memo": "",
      "revision": 3,
      "created_by": {
        "id": 1001,
        "name": "John Smith",
        "deleted": false
      },
      "created_at": "2026-01-15T09:30:00.000Z",
      "url": "https://app.boxhero-app.com/returns/90301",
      "count_of_items": 1,
      "total_quantity": 5
    }
  ],
  "count": 1,
  "limit": 100,
  "cursor": 90301,
  "has_more": false
}
```

**401**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}
```

**429**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/returns",
  "retryAfter": 60
}
```