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}

인증

Authorizationstring필수

Bearer <token> 형식의 Bearer 인증 헤더입니다. <token>에는 API 토큰을 넣습니다.

경로 파라미터

return_numberstring필수

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

응답

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 number 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/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>

응답 예시

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