Get a sales return by return number

Looks up a sales return by return number and returns the same payload as GET /returns/{return_id}.

Whitespace is ignored and letters are uppercased.

GEThttps://rest.boxhero-app.com/v1/returns/by-number/{return_number}

Xác thực

Authorizationstringbắt buộc

Header xác thực Bearer có dạng Bearer <token>, trong đó <token> là token API của bạn.

Tham số đường dẫn

return_numberstringbắt buộc

Return number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores.

Phản hồi

200The requested sales return.

itemReturnbắt buộc

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

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Return id.

return_numberstringbắt buộc

Return number.

return_timestringdate-timebắt buộc

Return date/time.

statusstringbắt buộc

Return status.

Giá trị có thể cóconfirmedin-progressdone

partnerEntitynullablebắt buộc

Customer for the sales return.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

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

deletedbooleanbắt buộc

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

orderOrderRefbắt buộc

Reference to the source sales order for a return.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Order id.

order_numberstringbắt buộc

Order number.

total_pricestringbắt buộc

Return total as a decimal string.

currency_codestringnullablebắt buộc

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

memostringbắt buộc

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

Optimistic-concurrency version.

created_byEntitybắt buộc

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.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

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

deletedbooleanbắt buộc

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

created_atstringdate-timebắt buộc

Server-side creation timestamp.

urlstringuribắt buộc

Web URL to view this return in the BoxHero app.

tagsarray of stringbắt buộc

Read-only tags parsed from the memo.

itemsarray of ReturnLinebắt buộc

Detailed return lines.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Return line id.

rankintegerminimum -9007199254740991, maximum 9007199254740991bắt buộc

Line rank in the return.

order_item_idintegerminimum 0, maximum 2147483647bắt buộc

Source order line id.

itemExtendedItemEntitynullablebắt buộc

Set when the line references a single item.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Item or bundle id.

namestringbắt buộc

Display name.

skustringbắt buộc

SKU. Empty string when unset.

barcodestringbắt buộc

Barcode. Empty string when unset.

deletedbooleanbắt buộc

Whether the underlying item or bundle is deleted.

bundleExtendedItemEntitynullablebắt buộc

Set when the line references a bundle.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Item or bundle id.

namestringbắt buộc

Display name.

skustringbắt buộc

SKU. Empty string when unset.

barcodestringbắt buộc

Barcode. Empty string when unset.

deletedbooleanbắt buộc

Whether the underlying item or bundle is deleted.

pricestringbắt buộc

Unit price as stored on the line.

quantitynumberbắt buộc

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

tax_namestringnullablebắt buộc

Tax name, or null when no tax is applied.

tax_ratestringnullablebắt buộc

Tax rate as a percentage string.

tax_inclusivebooleannullablebắt buộc

Whether the stored line price includes tax.

discount_namestringnullablebắt buộc

Discount name, or null when no discount is applied.

discount_typestringnullablebắt buộc

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

Giá trị có thể cópercentamount

discount_valuestringnullablebắt buộc

Discount percentage or absolute amount.

subtotalstringbắt buộc

price * quantity before discount and tax.

discount_amountstringbắt buộc

Discount amount applied to this line.

tax_amountstringbắt buộc

Inclusive plus exclusive tax amount for this line.

totalstringbắt buộc

Final line total after discount and exclusive tax.

tx_itemsarray of FulfillmentTxItembắt buộc

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

Hiển thị thuộc tính

itemExtendedItemEntitybắt buộc

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

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Item or bundle id.

namestringbắt buộc

Display name.

skustringbắt buộc

SKU. Empty string when unset.

barcodestringbắt buộc

Barcode. Empty string when unset.

deletedbooleanbắt buộc

Whether the underlying item or bundle is deleted.

ordered_quantitynumberbắt buộc

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

fulfilled_quantitynumberbắt buộc

Absolute quantity already fulfilled or received for this item.

pending_quantitynumberbắt buộc

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

transactionsarray of OrderTransactionSummarybắt buộc

Inventory transactions linked to this return.

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Location transaction id.

typestringbắt buộc

Fulfillment direction of an order-linked transaction.

Giá trị có thể cóinout

transaction_timestringdate-timebắt buộc

Effective transaction time.

to_locationEntitybắt buộc

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Id of the referenced entity.

namestringbắt buộc

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

deletedbooleanbắt buộc

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

count_of_itemsintegerminimum 0, maximum 9007199254740991bắt buộc

total_quantitynumberbắt buộc

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

401Missing or invalid API token.

idstringbắt buộc

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.

typestringbắt buộc

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

Giá trị có thể có/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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

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.

instancestringbắt buộc

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.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

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

idstringbắt buộc

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.

typestringbắt buộc

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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestringbắt buộc

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.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

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

idstringbắt buộc

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.

typestringbắt buộc

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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestringbắt buộc

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.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

Yêu cầu

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

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

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

Phản hồi

{
  "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 number was found in this team.",
  "instance": "/returns/by-number/R-1001"
}

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