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.

GEThttps://rest.boxhero-app.com/v1/returns

認証

Authorizationstring必須

Bearer <token> 形式の Bearer 認証ヘッダーです。<token> には APIトークンを指定します。

クエリパラメータ

statusesstring | array of string

Filter by one or more return statuses.

partner_idintegerminimum 0, maximum 2147483647

Filter by partner id.

return_numberstring

Filter by exact return number. Whitespace is ignored and letters are uppercased.

order_numberstring

Filter by exact source order number. Whitespace is ignored and letters are uppercased.

order_idintegerminimum 0, maximum 2147483647

Filter by source order id.

tagsstring | array of string

Filter by tags with all-match semantics.

returned_afterstringdate-time

Filter by return_time >= this timestamp.

returned_beforestringdate-time

Filter by return_time < this timestamp.

created_by_idintegerminimum 0, maximum 2147483647

Filter by creator member id.

cursorintegerminimum 0, maximum 2147483647

Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call.

limitintegerminimum 1, maximum 100

Page size. Accepts 1–100; defaults to 100.

レスポンス

200A page of sales returns.

itemsarray of SimpleReturn必須

Items in this page. Default ordering is by id ascending; see the resource’s list endpoint description for any per-resource overrides.

プロパティを表示

idintegerminimum 0, maximum 2147483647必須

Return id.

return_numberstring必須

Return number.

return_timestringdate-time必須

Return date/time.

statusstring必須

Return status.

指定可能な値confirmedin-progressdone

partnerEntitynullable必須

Customer for the sales return.

プロパティを表示

idintegerminimum 0, maximum 2147483647必須

Id of the referenced entity.

namestring必須

Display name of the entity at the time the transaction was recorded.

deletedboolean必須

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

orderOrderRef必須

Reference to the source sales order for a return.

プロパティを表示

idintegerminimum 0, maximum 2147483647必須

Order id.

order_numberstring必須

Order number.

total_pricestring必須

Return total as a decimal string.

currency_codestringnullable必須

Source sales order ISO currency code, or null when unset.

memostring必須

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991必須

Optimistic-concurrency version.

created_byEntity必須

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.

プロパティを表示

idintegerminimum 0, maximum 2147483647必須

Id of the referenced entity.

namestring必須

Display name of the entity at the time the transaction was recorded.

deletedboolean必須

true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.

created_atstringdate-time必須

Server-side creation timestamp.

urlstringuri必須

Web URL to view this return in the BoxHero app.

count_of_itemsintegerminimum 0, maximum 9007199254740991必須

Number of return lines.

total_quantitynumber必須

Sum of returned quantities. Bundle lines are exploded into component item quantities.

countintegerminimum 0, maximum 9007199254740991必須

Number of items in this page (items.length).

limitintegerminimum 0, maximum 9007199254740991必須

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullable必須

Cursor to pass as cursor in the next request. null when has_more is false.

has_moreboolean必須

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).

401Missing or invalid API token.

idstring必須

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.

typestring必須

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

titlestring必須

Human-readable summary of the error, in English.

correlationIDstring必須

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.

instancestring必須

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

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.

errorsarray 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.

プロパティを表示

patharray of string | number必須

messagestring必須

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

idstring必須

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.

typestring必須

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestring必須

Human-readable summary of the error, in English.

correlationIDstring必須

instancestring必須

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

errorsarray 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.

プロパティを表示

patharray of string | number必須

messagestring必須

リクエスト

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

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();

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()

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

レスポンス

{
  "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
}

{
  "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"
}

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