> 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/id/developers/api/reference/price-lists/get-price-list.md).

# Get a price list

> Returns a single price list by id, including its line items.

Each item references either an `item` or a `bundle`.

`GET https://rest.boxhero-app.com/v1/price-lists/{price_list_id}`

## Otorisasi

- `Authorization` (string, wajib): Header autentikasi Bearer dengan format `Bearer <token>`, dengan `<token>` berupa [token API](https://www.boxhero.io/docs/id/developers/api/authentication) Anda.

## Parameter path

- `price_list_id` (integer, minimum 0, maximum 2147483647, wajib): Price list id.

## Respons

**200** The requested price list.

- `item` (PriceList, wajib): A price list with its line items.

  - `id` (integer, minimum 0, maximum 2147483647, wajib): Price list id.
  - `name` (string, wajib): Price list display name.
  - `order_type` (string, wajib): `"purchase"` for purchase price lists; `"sales"` for sales price lists. A price list is tied to one order type.

    Nilai yang mungkin: `purchase`, `sales`
  - `currency_code` (string, nullable, wajib): ISO 4217 currency code, or `null` when unset.
  - `created_at` (string, date-time, wajib): Server-side creation timestamp.
  - `updated_at` (string, date-time, wajib): Last edit timestamp, or the creation timestamp when never edited.
  - `items` (array of PriceListItem, wajib): Line items, ordered by `rank` ascending.

    - `item` (ExtendedItemEntity, nullable, wajib): Set when this line references a single item; `null` for bundle lines.

      - `id` (integer, minimum 0, maximum 2147483647, wajib): Item or bundle id.
      - `name` (string, wajib): Display name.
      - `sku` (string, wajib): SKU. Empty string when unset.
      - `barcode` (string, wajib): Barcode. Empty string when unset.
      - `deleted` (boolean, wajib): Whether the underlying item or bundle is deleted.
    - `bundle` (ExtendedItemEntity, nullable, wajib): Set when this line references a bundle; `null` for item lines.

      - `id` (integer, minimum 0, maximum 2147483647, wajib): Item or bundle id.
      - `name` (string, wajib): Display name.
      - `sku` (string, wajib): SKU. Empty string when unset.
      - `barcode` (string, wajib): Barcode. Empty string when unset.
      - `deleted` (boolean, wajib): Whether the underlying item or bundle is deleted.
    - `price` (string, wajib): Unit price stored on this line.
    - `rank` (integer, minimum -9007199254740991, maximum 9007199254740991, wajib): Line position within the price list (0-based).

**401** Missing or invalid API token.

- `id` (string, wajib): 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, wajib): 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`
- `title` (string, wajib): Human-readable summary of the error, in English.
- `correlationID` (string, wajib): 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.
- `instance` (string, wajib): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `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 `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, wajib)
  - `message` (string, wajib)

**404** No price list with the given id was found in this team.

- `id` (string, wajib): 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, wajib): 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`
- `title` (string, wajib): Human-readable summary of the error, in English.
- `correlationID` (string, wajib): 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.
- `instance` (string, wajib): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `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 `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, wajib)
  - `message` (string, wajib)

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

- `id` (string, wajib): 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, wajib): 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`
- `title` (string, wajib): Human-readable summary of the error, in English.
- `correlationID` (string, wajib): 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.
- `instance` (string, wajib): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `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 `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, wajib)
  - `message` (string, wajib)

Permintaan

**cURL**

```bash
curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/price-lists/{price_list_id}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"
```

**JavaScript**

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

**HTTP**

```http
GET /v1/price-lists/{price_list_id} HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
```

Respons

**200**

```json
{
  "item": {
    "id": 81023,
    "name": "Wholesale prices",
    "order_type": "sales",
    "currency_code": "USD",
    "created_at": "2026-01-02T03:04:05.000Z",
    "updated_at": "2026-01-02T03:04:05.000Z",
    "items": [
      {
        "item": {
          "id": 14290445,
          "name": "Finish Setting Powder",
          "sku": "SKU-12345678",
          "barcode": "2097678335587",
          "deleted": false
        },
        "bundle": null,
        "price": "12.50",
        "rank": 0
      },
      {
        "item": null,
        "bundle": {
          "id": 4042,
          "name": "Starter Kit",
          "sku": "BUNDLE-STARTER",
          "barcode": "8801234567890",
          "deleted": false
        },
        "price": "24.00",
        "rank": 1
      }
    ]
  }
}
```

**401**

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

**404**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/not-found",
  "title": "No price list with the given id was found in this team.",
  "instance": "/price-lists/12345"
}
```

**429**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/price-lists/12345",
  "retryAfter": 60
}
```