Get a sales return

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

GEThttps://rest.boxhero-app.com/v1/returns/{return_id}

授权

Authorizationstring必填

Bearer <token> 格式的 Bearer 认证请求头，其中 <token> 为你的 API 令牌。

路径参数

return_idintegerminimum 0, maximum 2147483647必填

Return id.

响应

200The requested sales return.

itemReturn必填

A sales return with lines, per-item receiving progress, and linked transactions.

显示属性

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.

tagsarray of string必填

Read-only tags parsed from the memo.

itemsarray of ReturnLine必填

Detailed return lines.

显示属性

idintegerminimum 0, maximum 2147483647必填

Return line id.

rankintegerminimum -9007199254740991, maximum 9007199254740991必填

Line rank in the return.

order_item_idintegerminimum 0, maximum 2147483647必填

Source order line id.

itemExtendedItemEntitynullable必填

Set when the line references a single item.

显示属性

idintegerminimum 0, maximum 2147483647必填

Item or bundle id.

namestring必填

Display name.

skustring必填

SKU. Empty string when unset.

barcodestring必填

Barcode. Empty string when unset.

deletedboolean必填

Whether the underlying item or bundle is deleted.

bundleExtendedItemEntitynullable必填

Set when the line references a bundle.

显示属性

idintegerminimum 0, maximum 2147483647必填

Item or bundle id.

namestring必填

Display name.

skustring必填

SKU. Empty string when unset.

barcodestring必填

Barcode. Empty string when unset.

deletedboolean必填

Whether the underlying item or bundle is deleted.

pricestring必填

Unit price as stored on the line.

quantitynumber必填

Quantity. May include up to four decimal places in core data.

tax_namestringnullable必填

Tax name, or null when no tax is applied.

tax_ratestringnullable必填

Tax rate as a percentage string.

tax_inclusivebooleannullable必填

Whether the stored line price includes tax.

discount_namestringnullable必填

Discount name, or null when no discount is applied.

discount_typestringnullable必填

Discount type. "percent" is a 0-100 percentage; "amount" is an absolute amount.

可选值percentamount

discount_valuestringnullable必填

Discount percentage or absolute amount.

subtotalstring必填

price * quantity before discount and tax.

discount_amountstring必填

Discount amount applied to this line.

tax_amountstring必填

Inclusive plus exclusive tax amount for this line.

totalstring必填

Final line total after discount and exclusive tax.

tx_itemsarray of FulfillmentTxItem必填

Per-item receiving progress. Bundle return lines are exploded and duplicate items are collapsed.

显示属性

itemExtendedItemEntity必填

Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

显示属性

idintegerminimum 0, maximum 2147483647必填

Item or bundle id.

namestring必填

Display name.

skustring必填

SKU. Empty string when unset.

barcodestring必填

Barcode. Empty string when unset.

deletedboolean必填

Whether the underlying item or bundle is deleted.

ordered_quantitynumber必填

Ordered or returned quantity for this item. Bundle lines are exploded into component quantities and duplicate items are collapsed.

fulfilled_quantitynumber必填

Absolute quantity already fulfilled or received for this item.

pending_quantitynumber必填

Remaining quantity for this item, clamped to zero when over-fulfilled.

transactionsarray of OrderTransactionSummary必填

Inventory transactions linked to this return.

显示属性

idintegerminimum 0, maximum 2147483647必填

Location transaction id.

typestring必填

Fulfillment direction of an order-linked transaction.

可选值inout

transaction_timestringdate-time必填

Effective transaction time.

to_locationEntity必填

显示属性

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.

count_of_itemsintegerminimum 0, maximum 9007199254740991必填

total_quantitynumber必填

Quantity. May include up to four decimal places in core data.

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必填

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

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必填

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

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

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

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

响应

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

{
  "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/not-found",
  "title": "No return with the given id was found in this team.",
  "instance": "/returns/12345"
}

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