List sales orders

Returns a cursor-paginated list of active sales orders.

Ordered newest first by order_time, then by id (descending); the cursor follows this order. Line items, return totals, fulfillment progress, tags, and custom fields are available from the single-order endpoint.

GEThttps://rest.boxhero-app.com/v1/sales-orders

Autorização

Authorizationstringobrigatório

Cabeçalho de autenticação Bearer no formato Bearer <token>, em que <token> é o seu token de API.

Parâmetros de consulta

statusesstring | array of string

Filter by one or more order statuses.

partner_idintegerminimum 0, maximum 2147483647

Filter by partner id.

order_numberstring

Filter by exact order number. Whitespace is ignored and letters are uppercased.

tagsstring | array of string

Filter by tags with all-match semantics.

ordered_afterstringdate-time

Filter by order_time >= this timestamp.

ordered_beforestringdate-time

Filter by order_time < this timestamp.

estimated_afterstringdate-time

Filter by estimated_time >= this timestamp.

estimated_beforestringdate-time

Filter by estimated_time < this timestamp.

created_by_idintegerminimum 0, maximum 2147483647

Filter by creator member id.

cursorintegerminimum 0, maximum 2147483647

Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call.

limitintegerminimum 1, maximum 100

Page size. Accepts 1–100; defaults to 100.

Respostas

200A page of sales orders.

itemsarray of SimpleOrderobrigatório

Items in this page. Most resources are ordered by id ascending; transactions and orders/returns are ordered by time descending (see each list endpoint).

Mostrar propriedades

idintegerminimum 0, maximum 2147483647obrigatório

Order id.

order_numberstringobrigatório

Order number.

order_timestringdate-timeobrigatório

Order date/time.

estimated_timestringdate-time, nullableobrigatório

Estimated fulfillment date/time.

statusstringobrigatório

Order status. Purchase and sales orders may also be draft. Recording stock through the order's transaction endpoints advances the status automatically: confirmed becomes in-progress once any quantity is recorded, and done once nothing remains. A done order is never reverted by such transaction changes; only an explicit status update can change it.

Valores possíveisdraftconfirmedin-progressdone

partnerEntitynullableobrigatório

Supplier for purchase orders or customer for sales orders.

Mostrar propriedades

idintegerminimum 0, maximum 2147483647obrigatório

Id of the referenced entity.

namestringobrigatório

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

deletedbooleanobrigatório

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

total_pricestringobrigatório

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.

currency_codestringnullableobrigatório

ISO currency code, or null when unset.

memostringobrigatório

Free-text memo. Empty string when not set.

revisionintegerminimum -9007199254740991, maximum 9007199254740991obrigatório

Optimistic-concurrency version.

created_byEntityobrigatório

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.

Mostrar propriedades

idintegerminimum 0, maximum 2147483647obrigatório

Id of the referenced entity.

namestringobrigatório

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

deletedbooleanobrigatório

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

created_atstringdate-timeobrigatório

Server-side creation timestamp.

updated_atstringdate-timeobrigatório

Last edit timestamp, or creation timestamp when never edited.

urlstringuriobrigatório

Web URL to view this order in the BoxHero app.

count_of_itemsintegerminimum 0, maximum 9007199254740991obrigatório

Number of order lines.

total_quantitynumberobrigatório

Sum of ordered quantities. Bundle lines are exploded into component item quantities.

countintegerminimum 0, maximum 9007199254740991obrigatório

Number of items in this page (items.length).

limitintegerminimum 0, maximum 9007199254740991obrigatório

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullableobrigatório

Cursor to pass as cursor in the next request. null when has_more is false.

has_morebooleanobrigatório

True when another page is available. The cursor is monotonic — pass it as cursor on the next request to advance the page. Direction follows each resource's ordering (most resources: id ascending; transactions and orders/returns: time descending).

400Query validation failed, or the team is not in LOCATION mode.

idstringobrigatório

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.

typestringobrigatório

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

Valores possíveis/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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

Request correlation id (rq_ followed by 32 lowercase hex chars, no dashes — e.g. rq_01abf3...). Identical to the X-Correlation-Id response header. A client-supplied X-Correlation-Id request header (at most 128 chars of A-Z a-z 0-9 . _ : / = -) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated rq_… id.

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

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 request-validation /errors/invalid-request (400) responses. Absent on malformed-JSON 400, 413 body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include 403). Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Mostrar propriedades

patharray of string | numberobrigatório

messagestringobrigatório

401Missing, invalid, or revoked API token. /errors/tokens/required when no Bearer token is sent; /errors/tokens/invalid when the token is unknown or revoked (a revoked token may keep working for up to 60 seconds because validation results are cached).

idstringobrigatório

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.

typestringobrigatório

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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Mostrar propriedades

patharray of string | numberobrigatório

messagestringobrigatório

429Rate limit exceeded. Limits are per team and shared by all of the team's API tokens: 5 requests per second and 300 requests per minute. The RateLimit and X-RateLimit-* headers reflect the per-minute window; check them and Retry-After before retrying. This status is also returned when the client IP exceeds 30 failed authentication attempts within 60 seconds, even if the token is valid.

idstringobrigatório

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.

typestringobrigatório

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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Mostrar propriedades

patharray of string | numberobrigatório

messagestringobrigatório

Requisição

curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/sales-orders' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"

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

GET /v1/sales-orders HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>

Resposta

{
  "items": [
    {
      "id": 90101,
      "order_number": "PO-1001",
      "order_time": "2026-01-15T09:30:00.000Z",
      "estimated_time": "2026-01-20T00:00:00.000Z",
      "status": "in-progress",
      "partner": {
        "id": 431485,
        "name": "Acme Supply Co.",
        "deleted": false
      },
      "total_price": "2187",
      "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/purchase-orders/90101",
      "count_of_items": 2,
      "total_quantity": 120
    }
  ],
  "count": 1,
  "limit": 100,
  "cursor": null,
  "has_more": false
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/invalid-request",
  "title": "Query validation failed, or the team is not in LOCATION mode.",
  "instance": "/sales-orders"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "instance": "/sales-orders",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/sales-orders",
  "retryAfter": 60
}