Get a sales order
Returns a sales order by id, with lines, sales-return totals, per-item fulfillment progress, and linked stock transactions.
Use /v1/sales-orders/by-number/{order_number} for lookup by order number. Per-line pending quantity is not available because fulfillment transactions are tracked per item.
https://rest.boxhero-app.com/v1/sales-orders/{order_id}Authorizations
Section titled “Authorizations”Bearer authentication header of the form Bearer <token>, where <token> is your API token.
Path parameters
Section titled “Path parameters”Order id. Use GET /orders/by-number/{order_number} to look up by order number.
Responses
Section titled “Responses”200The requested sales order.
A sales order with lines, per-line sales-return totals, per-item fulfillment progress, linked transactions, and custom fields.
Show properties
Order id.
Order number.
Order date/time.
Estimated fulfillment date/time.
Order status. Purchase and sales orders may also be draft.
Possible valuesdraftconfirmedin-progressdone
Supplier for purchase orders or customer for sales orders.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Cached order total as a decimal string: the sum of the line totals plus any additional costs. Does not equal the sum of items[].total when the order carries costs.
ISO currency code, or null when unset.
Free-text memo. Empty string when not set.
Optimistic-concurrency version.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Server-side creation timestamp.
Last edit timestamp, or creation timestamp when never edited.
Web URL to view this order in the BoxHero app.
Read-only tags parsed from the memo.
Ordered custom field name-value pairs.
Show properties
Detailed order lines, including per-line sales-return totals.
Show properties
Order line id.
Line rank in the order.
Set when the line references a single item.
Show properties
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Set when the line references a bundle.
Show properties
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Unit price as stored on the line.
Quantity. May include up to four decimal places in core data.
Tax name, or null when no tax is applied.
Tax rate as a percentage string.
Whether the stored line price includes tax.
Discount name, or null when no discount is applied.
Discount type. "percent" is a 0-100 percentage; "amount" is an absolute amount.
Possible valuespercentamount
Discount percentage or absolute amount.
price * quantity before discount and tax.
Discount amount applied to this line.
Inclusive plus exclusive tax amount for this line.
Final line total after discount and exclusive tax.
Quantity already returned across this order’s sales returns.
Amount already returned across this order’s sales returns.
Additional costs attached to the order, ordered by rank. Included in total_price but not in any items[] figure.
Show properties
Cost name.
Cost amount. Negative for a deduction such as a prepayment. Additional costs carry no tax or discount, so the amount is the final value.
Cost rank in the order.
Per-item fulfillment progress. Bundle lines are exploded and duplicate items are collapsed.
Show properties
Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.
Show properties
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Ordered or returned quantity for this item. Bundle lines are exploded into component quantities and duplicate items are collapsed.
Absolute quantity already fulfilled or received for this item.
Remaining quantity for this item, clamped to zero when over-fulfilled.
Inventory transactions linked to this order.
Show properties
Location transaction id.
Fulfillment direction of an order-linked transaction.
Possible valuesinout
Effective transaction time.
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.
Show properties
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Quantity. May include up to four decimal places in core data.
401Missing or invalid API token.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Possible values/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Show properties
404No sales order with the given id or number was found in this team.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Possible values/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Show properties
429Rate limit exceeded. Check RateLimit, Retry-After, and X-RateLimit-* response headers before retrying.
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.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Possible values/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
Human-readable summary of the error, in English.
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.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
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.
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.
Show properties
Request
curl --request GET \ --url 'https://rest.boxhero-app.com/v1/sales-orders/{order_id}' \ --header "Authorization: Bearer $BOXHERO_API_TOKEN"const response = await fetch("https://rest.boxhero-app.com/v1/sales-orders/{order_id}", { method: "GET", headers: { Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://rest.boxhero-app.com/v1/sales-orders/{order_id}", headers={ "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"], },)data = response.json()GET /v1/sales-orders/{order_id} HTTP/1.1Host: rest.boxhero-app.comAuthorization: Bearer <token>Response
{ "item": { "id": 90201, "order_number": "SO-2001", "order_time": "2026-01-15T09:30:00.000Z", "estimated_time": "2026-01-20T00:00:00.000Z", "status": "confirmed", "partner": { "id": 431488, "name": "Northwind Retail", "deleted": false }, "total_price": "2187.56", "currency_code": "USD", "memo": "", "revision": 3, "created_by": { "id": 1001, "name": "John Smith", "deleted": false }, "created_at": "2026-01-15T09:30:00.000Z", "updated_at": "2026-01-15T09:30:00.000Z", "url": "https://app.boxhero-app.com/sales-orders/90201", "tags": [ "wholesale" ], "custom_fields": [], "items": [ { "id": 700201, "rank": 0, "item": { "id": 14290445, "name": "Finish Setting Powder", "sku": "SKU-12345678", "barcode": "2097678335587", "deleted": false }, "bundle": null, "price": "19.99", "quantity": 100, "tax_name": null, "tax_rate": null, "tax_inclusive": null, "discount_name": null, "discount_type": null, "discount_value": null, "subtotal": "1999.00", "discount_amount": "0.00", "tax_amount": "0.00", "total": "1999.00", "return_quantity": 5, "return_amount": "99.95" }, { "id": 700202, "rank": 1, "item": { "id": 14290446, "name": "Hydrating Face Toner", "sku": "SKU-12345679", "barcode": "2097678335588", "deleted": false }, "bundle": null, "price": "12.50", "quantity": 20, "tax_name": "Sales Tax", "tax_rate": "8.25", "tax_inclusive": false, "discount_name": "Volume discount", "discount_type": "percent", "discount_value": "10", "subtotal": "250.00", "discount_amount": "25.00", "tax_amount": "18.56", "total": "243.56", "return_quantity": 0, "return_amount": "0.00" } ], "costs": [ { "name": "Shipping fee", "amount": "45.00", "rank": 0 }, { "name": "Prepayment", "amount": "-100.00", "rank": 1 } ], "tx_items": [ { "item": { "id": 14290445, "name": "Finish Setting Powder", "sku": "SKU-12345678", "barcode": "2097678335587", "deleted": false }, "ordered_quantity": 100, "fulfilled_quantity": 60, "pending_quantity": 40 }, { "item": { "id": 14290446, "name": "Hydrating Face Toner", "sku": "SKU-12345679", "barcode": "2097678335588", "deleted": false }, "ordered_quantity": 20, "fulfilled_quantity": 20, "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": 100 } ] }}{ "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 sales order with the given id or number was found in this team.", "instance": "/sales-orders/12345"}{ "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a", "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2", "type": "/errors/too-many-requests", "title": "Too many requests.", "instance": "/sales-orders/12345", "retryAfter": 60}