> 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/get-return.md).

# Get a sales return

> Returns a sales return by id, with source order reference, lines, per-item receiving progress, and linked stock transactions.

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

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

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

## Параметры пути

- `return_id` (integer, minimum 0, maximum 2147483647, обязательный): Return id.

## Ответы

**200** The requested sales return.

- `item` (Return, обязательный): A sales return with lines, per-item receiving progress, and linked transactions.

  - `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.
  - `tags` (array of string, обязательный): Read-only tags parsed from the memo.
  - `items` (array of ReturnLine, обязательный): Detailed return lines.

    - `id` (integer, minimum 0, maximum 2147483647, обязательный): Return line id.
    - `rank` (integer, minimum -9007199254740991, maximum 9007199254740991, обязательный): Line rank in the return.
    - `order_item_id` (integer, minimum 0, maximum 2147483647, обязательный): Source order line id.
    - `item` (ExtendedItemEntity, nullable, обязательный): Set when the line references a single item.

      - `id` (integer, minimum 0, maximum 2147483647, обязательный): Item or bundle id.
      - `name` (string, обязательный): Display name.
      - `sku` (string, обязательный): SKU. Empty string when unset.
      - `barcode` (string, обязательный): Barcode. Empty string when unset.
      - `deleted` (boolean, обязательный): Whether the underlying item or bundle is deleted.
    - `bundle` (ExtendedItemEntity, nullable, обязательный): Set when the line references a bundle.

      - `id` (integer, minimum 0, maximum 2147483647, обязательный): Item or bundle id.
      - `name` (string, обязательный): Display name.
      - `sku` (string, обязательный): SKU. Empty string when unset.
      - `barcode` (string, обязательный): Barcode. Empty string when unset.
      - `deleted` (boolean, обязательный): Whether the underlying item or bundle is deleted.
    - `price` (string, обязательный): Unit price as stored on the line.
    - `quantity` (number, обязательный): Quantity. May include up to four decimal places in core data.
    - `tax_name` (string, nullable, обязательный): Tax name, or null when no tax is applied.
    - `tax_rate` (string, nullable, обязательный): Tax rate as a percentage string.
    - `tax_inclusive` (boolean, nullable, обязательный): Whether the stored line price includes tax.
    - `discount_name` (string, nullable, обязательный): Discount name, or null when no discount is applied.
    - `discount_type` (string, nullable, обязательный): Discount type. `"percent"` is a 0-100 percentage; `"amount"` is an absolute amount.

      Возможные значения: `percent`, `amount`
    - `discount_value` (string, nullable, обязательный): Discount percentage or absolute amount.
    - `subtotal` (string, обязательный): price \* quantity before discount and tax.
    - `discount_amount` (string, обязательный): Discount amount applied to this line.
    - `tax_amount` (string, обязательный): Inclusive plus exclusive tax amount for this line.
    - `total` (string, обязательный): Final line total after discount and exclusive tax.
  - `tx_items` (array of FulfillmentTxItem, обязательный): Per-item receiving progress. Bundle return lines are exploded and duplicate items are collapsed.

    - `item` (ExtendedItemEntity, обязательный): Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

      - `id` (integer, minimum 0, maximum 2147483647, обязательный): Item or bundle id.
      - `name` (string, обязательный): Display name.
      - `sku` (string, обязательный): SKU. Empty string when unset.
      - `barcode` (string, обязательный): Barcode. Empty string when unset.
      - `deleted` (boolean, обязательный): Whether the underlying item or bundle is deleted.
    - `ordered_quantity` (number, обязательный): Ordered or returned quantity for this item. Bundle lines are exploded into component quantities and duplicate items are collapsed.
    - `fulfilled_quantity` (number, обязательный): Absolute quantity already fulfilled or received for this item.
    - `pending_quantity` (number, обязательный): Remaining quantity for this item, clamped to zero when over-fulfilled.
  - `transactions` (array of OrderTransactionSummary, обязательный): Inventory transactions linked to this return.

    - `id` (integer, minimum 0, maximum 2147483647, обязательный): Location transaction id.
    - `type` (string, обязательный): Fulfillment direction of an order-linked transaction.

      Возможные значения: `in`, `out`
    - `transaction_time` (string, date-time, обязательный): Effective transaction time.
    - `to_location` (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.
    - `count_of_items` (integer, minimum 0, maximum 9007199254740991, обязательный)
    - `total_quantity` (number, обязательный): Quantity. May include up to four decimal places in core data.

**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, обязательный)

**404** No return with the given id was found in this team.

- `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/{return_id}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"
```

**JavaScript**

```javascript
const response = await fetch("https://rest.boxhero-app.com/v1/returns/{return_id}", {
  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/{return_id}",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()
```

**HTTP**

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

Ответ

**200**

```json
{
  "item": {
    "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",
    "tags": [],
    "items": [
      {
        "id": 700301,
        "rank": 0,
        "order_item_id": 700201,
        "item": {
          "id": 14290445,
          "name": "Finish Setting Powder",
          "sku": "SKU-12345678",
          "barcode": "2097678335587",
          "deleted": false
        },
        "bundle": null,
        "price": "19.99",
        "quantity": 5,
        "tax_name": null,
        "tax_rate": null,
        "tax_inclusive": null,
        "discount_name": null,
        "discount_type": null,
        "discount_value": null,
        "subtotal": "99.95",
        "discount_amount": "0.00",
        "tax_amount": "0.00",
        "total": "99.95"
      }
    ],
    "tx_items": [
      {
        "item": {
          "id": 14290445,
          "name": "Finish Setting Powder",
          "sku": "SKU-12345678",
          "barcode": "2097678335587",
          "deleted": false
        },
        "ordered_quantity": 5,
        "fulfilled_quantity": 5,
        "pending_quantity": 0
      }
    ],
    "transactions": [
      {
        "id": 14012345,
        "type": "out",
        "transaction_time": "2026-01-16T11:00:00.000Z",
        "to_location": {
          "id": 47041,
          "name": "Warehouse",
          "deleted": false
        },
        "count_of_items": 1,
        "total_quantity": 5
      }
    ]
  }
}
```

**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"
}
```

**404**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/not-found",
  "title": "No return with the given id was found in this team.",
  "instance": "/returns/12345"
}
```

**429**

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