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}

Otorisasi

Authorizationstringwajib

Header autentikasi Bearer dengan format Bearer <token>, dengan <token> berupa token API Anda.

Parameter path

return_idintegerminimum 0, maximum 2147483647wajib

Return id.

Respons

200The requested sales return.

itemReturnwajib

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

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Return id.

return_numberstringwajib

Return number.

return_timestringdate-timewajib

Return date/time.

statusstringwajib

Return status.

Nilai yang mungkinconfirmedin-progressdone

partnerEntitynullablewajib

Customer for the sales return.

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Id of the referenced entity.

namestringwajib

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

deletedbooleanwajib

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

orderOrderRefwajib

Reference to the source sales order for a return.

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Order id.

order_numberstringwajib

Order number.

total_pricestringwajib

Return total as a decimal string.

currency_codestringnullablewajib

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

memostringwajib

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991wajib

Optimistic-concurrency version.

created_byEntitywajib

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.

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Id of the referenced entity.

namestringwajib

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

deletedbooleanwajib

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

created_atstringdate-timewajib

Server-side creation timestamp.

urlstringuriwajib

Web URL to view this return in the BoxHero app.

tagsarray of stringwajib

Read-only tags parsed from the memo.

itemsarray of ReturnLinewajib

Detailed return lines.

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Return line id.

rankintegerminimum -9007199254740991, maximum 9007199254740991wajib

Line rank in the return.

order_item_idintegerminimum 0, maximum 2147483647wajib

Source order line id.

itemExtendedItemEntitynullablewajib

Set when the line references a single item.

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Item or bundle id.

namestringwajib

Display name.

skustringwajib

SKU. Empty string when unset.

barcodestringwajib

Barcode. Empty string when unset.

deletedbooleanwajib

Whether the underlying item or bundle is deleted.

bundleExtendedItemEntitynullablewajib

Set when the line references a bundle.

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Item or bundle id.

namestringwajib

Display name.

skustringwajib

SKU. Empty string when unset.

barcodestringwajib

Barcode. Empty string when unset.

deletedbooleanwajib

Whether the underlying item or bundle is deleted.

pricestringwajib

Unit price as stored on the line.

quantitynumberwajib

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

tax_namestringnullablewajib

Tax name, or null when no tax is applied.

tax_ratestringnullablewajib

Tax rate as a percentage string.

tax_inclusivebooleannullablewajib

Whether the stored line price includes tax.

discount_namestringnullablewajib

Discount name, or null when no discount is applied.

discount_typestringnullablewajib

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

Nilai yang mungkinpercentamount

discount_valuestringnullablewajib

Discount percentage or absolute amount.

subtotalstringwajib

price * quantity before discount and tax.

discount_amountstringwajib

Discount amount applied to this line.

tax_amountstringwajib

Inclusive plus exclusive tax amount for this line.

totalstringwajib

Final line total after discount and exclusive tax.

tx_itemsarray of FulfillmentTxItemwajib

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

Tampilkan properti

itemExtendedItemEntitywajib

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

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Item or bundle id.

namestringwajib

Display name.

skustringwajib

SKU. Empty string when unset.

barcodestringwajib

Barcode. Empty string when unset.

deletedbooleanwajib

Whether the underlying item or bundle is deleted.

ordered_quantitynumberwajib

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

fulfilled_quantitynumberwajib

Absolute quantity already fulfilled or received for this item.

pending_quantitynumberwajib

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

transactionsarray of OrderTransactionSummarywajib

Inventory transactions linked to this return.

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Location transaction id.

typestringwajib

Fulfillment direction of an order-linked transaction.

Nilai yang mungkininout

transaction_timestringdate-timewajib

Effective transaction time.

to_locationEntitywajib

Tampilkan properti

idintegerminimum 0, maximum 2147483647wajib

Id of the referenced entity.

namestringwajib

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

deletedbooleanwajib

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

count_of_itemsintegerminimum 0, maximum 9007199254740991wajib

total_quantitynumberwajib

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

401Missing or invalid API token.

idstringwajib

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.

typestringwajib

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

Nilai yang mungkin/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

titlestringwajib

Human-readable summary of the error, in English.

correlationIDstringwajib

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.

instancestringwajib

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.

Tampilkan properti

patharray of string | numberwajib

messagestringwajib

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

idstringwajib

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.

typestringwajib

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

titlestringwajib

Human-readable summary of the error, in English.

correlationIDstringwajib

instancestringwajib

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.

Tampilkan properti

patharray of string | numberwajib

messagestringwajib

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

idstringwajib

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.

typestringwajib

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

titlestringwajib

Human-readable summary of the error, in English.

correlationIDstringwajib

instancestringwajib

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.

Tampilkan properti

patharray of string | numberwajib

messagestringwajib

Permintaan

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>

Respons

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