> 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.md).

# Price lists

> Price lists — saved unit prices for items and bundles, each tied to purchase or sales orders.

## Objek PriceList

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 of the price list's own fields (name, order type, currency), or the creation timestamp when never edited. Not updated when only line items change.
- `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).

Contoh

```json
{
  "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.5",
      "rank": 0
    },
    {
      "item": null,
      "bundle": {
        "id": 4042,
        "name": "Starter Kit",
        "sku": "BUNDLE-STARTER",
        "barcode": "8801234567890",
        "deleted": false
      },
      "price": "24",
      "rank": 1
    }
  ]
}
```

## Endpoint

- [List price lists](https://www.boxhero.io/docs/id/developers/api/reference/price-lists/list-price-lists.md) `GET /v1/price-lists`
- [Create a price list](https://www.boxhero.io/docs/id/developers/api/reference/price-lists/create-price-list.md) `POST /v1/price-lists`
- [Get a price list](https://www.boxhero.io/docs/id/developers/api/reference/price-lists/get-price-list.md) `GET /v1/price-lists/{price_list_id}`
- [Update a price list](https://www.boxhero.io/docs/id/developers/api/reference/price-lists/update-price-list.md) `PUT /v1/price-lists/{price_list_id}`
- [Delete a price list](https://www.boxhero.io/docs/id/developers/api/reference/price-lists/delete-price-list.md) `DELETE /v1/price-lists/{price_list_id}`