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 в формате Bearer <token>, где <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
}