> 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/zh-cn/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 <token>` 格式的 Bearer 认证请求头，其中 `<token>` 为你的 [API 令牌](https://www.boxhero.io/docs/zh-cn/developers/api/authentication.md)。

## 路径参数

- `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. Recording stock through the return's transaction endpoints advances the status automatically: `confirmed` becomes `in-progress` once any quantity is received, and `done` once nothing remains. A `done` return is never reverted by such transaction changes.

    可选值: `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, 必填): Returned line amount, not a unit price: the source order line's total (including tax and discount) scaled by returned quantity / ordered quantity. Equal to `subtotal` and `total`.
    - `quantity` (number, 必填): Quantity. May include up to four decimal places in core data.
    - `tax_name` (string, nullable, 必填): Always null on return lines.
    - `tax_rate` (string, nullable, 必填): Always null on return lines.
    - `tax_inclusive` (boolean, nullable, 必填): Always null on return lines.
    - `discount_name` (string, nullable, 必填): Always null on return lines.
    - `discount_type` (string, nullable, 必填): Always null on return lines.

      可选值: `percent`, `amount`
    - `discount_value` (string, nullable, 必填): Always null on return lines.
    - `subtotal` (string, 必填): Same as `price`: the returned line amount.
    - `discount_amount` (string, 必填): Always "0"; any source discount is already reflected in `price`.
    - `tax_amount` (string, 必填): Always "0"; any source tax is already reflected in `price`.
    - `total` (string, 必填): Same as `price`: the returned line amount.
  - `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.

**400** Invalid path parameter, or the team is not in LOCATION mode.

- `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. A client-supplied `X-Correlation-Id` request header (at most 128 chars of `A-Z a-z 0-9 . _ : / = -`) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated `rq_…` id.
- `instance` (string): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix. Absent on unknown-path `404` and unexpected `500` responses.
- `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 request-validation `/errors/invalid-request` (400) responses. Absent on malformed-JSON `400`, `413` body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include `403`). Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, 必填)
  - `message` (string, 必填)

**401** Missing, invalid, or revoked API token. `/errors/tokens/required` when no Bearer token is sent; `/errors/tokens/invalid` when the token is unknown or revoked (a revoked token may keep working for up to 60 seconds because validation results are cached).

- `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. A client-supplied `X-Correlation-Id` request header (at most 128 chars of `A-Z a-z 0-9 . _ : / = -`) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated `rq_…` id.
- `instance` (string): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix. Absent on unknown-path `404` and unexpected `500` responses.
- `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 request-validation `/errors/invalid-request` (400) responses. Absent on malformed-JSON `400`, `413` body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include `403`). 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. A client-supplied `X-Correlation-Id` request header (at most 128 chars of `A-Z a-z 0-9 . _ : / = -`) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated `rq_…` id.
- `instance` (string): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix. Absent on unknown-path `404` and unexpected `500` responses.
- `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 request-validation `/errors/invalid-request` (400) responses. Absent on malformed-JSON `400`, `413` body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include `403`). 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. Limits are per team and shared by all of the team's API tokens: 5 requests per second and 300 requests per minute. The `RateLimit` and `X-RateLimit-*` headers reflect the per-minute window; check them and `Retry-After` before retrying. This status is also returned when the client IP exceeds 30 failed authentication attempts within 60 seconds, even if the token is valid.

- `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. A client-supplied `X-Correlation-Id` request header (at most 128 chars of `A-Z a-z 0-9 . _ : / = -`) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated `rq_…` id.
- `instance` (string): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix. Absent on unknown-path `404` and unexpected `500` responses.
- `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 request-validation `/errors/invalid-request` (400) responses. Absent on malformed-JSON `400`, `413` body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include `403`). 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": "done",
    "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": "99.95",
        "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",
        "tax_amount": "0",
        "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": "in",
        "transaction_time": "2026-01-16T11:00:00.000Z",
        "to_location": {
          "id": 47041,
          "name": "Warehouse",
          "deleted": false
        },
        "count_of_items": 1,
        "total_quantity": 5
      }
    ]
  }
}
```

**400**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/invalid-request",
  "title": "Invalid path parameter, or the team is not in LOCATION mode.",
  "instance": "/returns/12345"
}
```

**401**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "instance": "/returns/12345",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}
```

**404**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/not-found",
  "title": "No return with the given id was found in this team.",
  "instance": "/returns/12345"
}
```

**429**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/returns/12345",
  "retryAfter": 60
}
```