> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/vi/developers/api/reference/purchase-orders/get-purchase-order-by-number.md).

# Get a purchase order by order number

> Looks up a purchase order by order number and returns the same payload as the by-id endpoint.

Whitespace is ignored and letters are uppercased.

`GET https://rest.boxhero-app.com/v1/purchase-orders/by-number/{order_number}`

## Xác thực

- `Authorization` (string, bắt buộc): Header xác thực Bearer có dạng `Bearer <token>`, trong đó `<token>` là [token API](https://www.boxhero.io/docs/vi/developers/api/authentication.md) của bạn.

## Tham số đường dẫn

- `order_number` (string, bắt buộc): Order number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores.

## Phản hồi

**200** The requested purchase order.

- `item` (PurchaseOrder, bắt buộc): A purchase order with lines, per-item fulfillment progress, linked transactions, and custom fields.

  - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Order id.
  - `order_number` (string, bắt buộc): Order number.
  - `order_time` (string, date-time, bắt buộc): Order date/time.
  - `estimated_time` (string, date-time, nullable, bắt buộc): Estimated fulfillment date/time.
  - `status` (string, bắt buộc): 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.

    Giá trị có thể có: `draft`, `confirmed`, `in-progress`, `done`
  - `partner` (Entity, nullable, bắt buộc): Supplier for purchase orders or customer for sales orders.

    - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Id of the referenced entity.
    - `name` (string, bắt buộc): Display name of the entity at the time the transaction was recorded.
    - `deleted` (boolean, bắt buộc): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
  - `total_price` (string, bắt buộc): 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_code` (string, nullable, bắt buộc): ISO currency code, or null when unset.
  - `memo` (string, bắt buộc): Free-text memo. Empty string when not set.
  - `revision` (integer, minimum -9007199254740991, maximum 9007199254740991, bắt buộc): Optimistic-concurrency version.
  - `created_by` (Entity, bắt buộc): 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.

    - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Id of the referenced entity.
    - `name` (string, bắt buộc): Display name of the entity at the time the transaction was recorded.
    - `deleted` (boolean, bắt buộc): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
  - `created_at` (string, date-time, bắt buộc): Server-side creation timestamp.
  - `updated_at` (string, date-time, bắt buộc): Last edit timestamp, or creation timestamp when never edited.
  - `url` (string, uri, bắt buộc): Web URL to view this order in the BoxHero app.
  - `tags` (array of string, bắt buộc): Read-only tags parsed from the memo.
  - `custom_fields` (array of object, bắt buộc): Ordered custom field name-value pairs.

    - `name` (string, bắt buộc)
    - `value` (string, bắt buộc)
  - `items` (array of PurchaseOrderLine, bắt buộc): Detailed order lines.

    - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Order line id.
    - `rank` (integer, minimum -9007199254740991, maximum 9007199254740991, bắt buộc): Line rank in the order.
    - `item` (ExtendedItemEntity, nullable, bắt buộc): Set when the line references a single item.

      - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Item or bundle id.
      - `name` (string, bắt buộc): Display name.
      - `sku` (string, bắt buộc): SKU. Empty string when unset.
      - `barcode` (string, bắt buộc): Barcode. Empty string when unset.
      - `deleted` (boolean, bắt buộc): Whether the underlying item or bundle is deleted.
    - `bundle` (ExtendedItemEntity, nullable, bắt buộc): Set when the line references a bundle.

      - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Item or bundle id.
      - `name` (string, bắt buộc): Display name.
      - `sku` (string, bắt buộc): SKU. Empty string when unset.
      - `barcode` (string, bắt buộc): Barcode. Empty string when unset.
      - `deleted` (boolean, bắt buộc): Whether the underlying item or bundle is deleted.
    - `price` (string, bắt buộc): Unit price as stored on the line.
    - `quantity` (number, bắt buộc): Quantity. May include up to four decimal places in core data.
    - `tax_name` (string, nullable, bắt buộc): Tax name, or null when no tax is applied.
    - `tax_rate` (string, nullable, bắt buộc): Tax rate as a percentage string.
    - `tax_inclusive` (boolean, nullable, bắt buộc): Whether the stored line price includes tax.
    - `discount_name` (string, nullable, bắt buộc): Discount name, or null when no discount is applied.
    - `discount_type` (string, nullable, bắt buộc): Discount type. `"percent"` is a 0-100 percentage; `"amount"` is an absolute amount.

      Giá trị có thể có: `percent`, `amount`
    - `discount_value` (string, nullable, bắt buộc): Discount percentage or absolute amount.
    - `subtotal` (string, bắt buộc): price \* quantity before discount and tax.
    - `discount_amount` (string, bắt buộc): Discount amount applied to this line.
    - `tax_amount` (string, bắt buộc): Inclusive plus exclusive tax amount for this line.
    - `total` (string, bắt buộc): Final line total after discount and exclusive tax.
  - `costs` (array of OrderCost, bắt buộc): Additional costs attached to the order, ordered by rank. Included in total_price but not in any items\[\] figure.

    - `name` (string, bắt buộc): Cost name.
    - `amount` (string, bắt buộc): Cost amount. Negative for a deduction such as a prepayment. Additional costs carry no tax or discount, so the amount is the final value.
    - `rank` (integer, minimum -9007199254740991, maximum 9007199254740991, bắt buộc): Cost rank in the order.
  - `tx_items` (array of FulfillmentTxItem, bắt buộc): Per-item fulfillment progress. Bundle lines are exploded and duplicate items are collapsed.

    - `item` (ExtendedItemEntity, bắt buộc): Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

      - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Item or bundle id.
      - `name` (string, bắt buộc): Display name.
      - `sku` (string, bắt buộc): SKU. Empty string when unset.
      - `barcode` (string, bắt buộc): Barcode. Empty string when unset.
      - `deleted` (boolean, bắt buộc): Whether the underlying item or bundle is deleted.
    - `ordered_quantity` (number, bắt buộc): Ordered or returned quantity for this item. Bundle lines are exploded into component quantities and duplicate items are collapsed.
    - `fulfilled_quantity` (number, bắt buộc): Absolute quantity already fulfilled or received for this item.
    - `pending_quantity` (number, bắt buộc): Remaining quantity for this item, clamped to zero when over-fulfilled.
  - `transactions` (array of OrderTransactionSummary, bắt buộc): Inventory transactions linked to this order.

    - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Location transaction id.
    - `type` (string, bắt buộc): Fulfillment direction of an order-linked transaction.

      Giá trị có thể có: `in`, `out`
    - `transaction_time` (string, date-time, bắt buộc): Effective transaction time.
    - `to_location` (Entity, bắt buộc): 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.

      - `id` (integer, minimum 0, maximum 2147483647, bắt buộc): Id of the referenced entity.
      - `name` (string, bắt buộc): Display name of the entity at the time the transaction was recorded.
      - `deleted` (boolean, bắt buộc): `true` when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
    - `count_of_items` (integer, minimum 0, maximum 9007199254740991, bắt buộc)
    - `total_quantity` (number, bắt buộc): Quantity. May include up to four decimal places in core data.

**400** Invalid path parameter, or the team is not in LOCATION mode.

- `id` (string, bắt buộc): 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.
- `type` (string, bắt buộc): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Giá trị có thể có: `/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`
- `title` (string, bắt buộc): Human-readable summary of the error, in English.
- `correlationID` (string, bắt buộc): 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.
- `instance` (string): 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.
- `code` (string): 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`.
- `errors` (array 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`.

  - `path` (array of string | number, bắt buộc)
  - `message` (string, bắt buộc)

**401** Missing, 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).

- `id` (string, bắt buộc): 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.
- `type` (string, bắt buộc): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Giá trị có thể có: `/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`
- `title` (string, bắt buộc): Human-readable summary of the error, in English.
- `correlationID` (string, bắt buộc): 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.
- `instance` (string): 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.
- `code` (string): 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`.
- `errors` (array 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`.

  - `path` (array of string | number, bắt buộc)
  - `message` (string, bắt buộc)

**404** No purchase order with the given order number was found in this team.

- `id` (string, bắt buộc): 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.
- `type` (string, bắt buộc): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Giá trị có thể có: `/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`
- `title` (string, bắt buộc): Human-readable summary of the error, in English.
- `correlationID` (string, bắt buộc): 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.
- `instance` (string): 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.
- `code` (string): 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`.
- `errors` (array 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`.

  - `path` (array of string | number, bắt buộc)
  - `message` (string, bắt buộc)

**429** Rate 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.

- `id` (string, bắt buộc): 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.
- `type` (string, bắt buộc): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Giá trị có thể có: `/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`
- `title` (string, bắt buộc): Human-readable summary of the error, in English.
- `correlationID` (string, bắt buộc): 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.
- `instance` (string): 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.
- `code` (string): 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`.
- `errors` (array 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`.

  - `path` (array of string | number, bắt buộc)
  - `message` (string, bắt buộc)

Yêu cầu

**cURL**

```bash
curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/purchase-orders/by-number/{order_number}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"
```

**JavaScript**

```javascript
const response = await fetch("https://rest.boxhero-app.com/v1/purchase-orders/by-number/{order_number}", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
  },
});
const data = await response.json();
```

**Python**

```python
import os
import requests

response = requests.get(
    "https://rest.boxhero-app.com/v1/purchase-orders/by-number/{order_number}",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()
```

**HTTP**

```http
GET /v1/purchase-orders/by-number/{order_number} HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
```

Phản hồi

**200**

```json
{
  "item": {
    "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",
    "tags": [
      "restock"
    ],
    "custom_fields": [],
    "items": [
      {
        "id": 700101,
        "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",
        "discount_amount": "0",
        "tax_amount": "0",
        "total": "1999"
      },
      {
        "id": 700102,
        "rank": 1,
        "item": {
          "id": 14290446,
          "name": "Hydrating Face Toner",
          "sku": "SKU-12345679",
          "barcode": "2097678335588",
          "deleted": false
        },
        "bundle": null,
        "price": "12.5",
        "quantity": 20,
        "tax_name": "Sales Tax",
        "tax_rate": "8",
        "tax_inclusive": false,
        "discount_name": "Volume discount",
        "discount_type": "percent",
        "discount_value": "10",
        "subtotal": "250",
        "discount_amount": "25",
        "tax_amount": "18",
        "total": "243"
      }
    ],
    "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": "in",
        "transaction_time": "2026-01-16T11:00:00.000Z",
        "to_location": {
          "id": 47041,
          "name": "Warehouse",
          "deleted": false
        },
        "count_of_items": 2,
        "total_quantity": 80
      }
    ]
  }
}
```

**400**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/invalid-request",
  "title": "Invalid path parameter, or the team is not in LOCATION mode.",
  "instance": "/purchase-orders/by-number/PO-1001"
}
```

**401**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "instance": "/purchase-orders/by-number/PO-1001",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}
```

**404**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/not-found",
  "title": "No purchase order with the given order number was found in this team.",
  "instance": "/purchase-orders/by-number/PO-1001"
}
```

**429**

```json
{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/purchase-orders/by-number/PO-1001",
  "retryAfter": 60
}
```