List price lists

Returns a cursor-paginated list of price lists (id ascending), without their line items.

Pass order_type to filter by purchase or sales price lists.

GEThttps://rest.boxhero-app.com/v1/price-lists

認証

Authorizationstring必須

Bearer <token> 形式の Bearer 認証ヘッダーです。<token> には APIトークンを指定します。

クエリパラメータ

order_typestring

"purchase" for purchase price lists; "sales" for sales price lists. A price list is tied to one order type.

指定可能な値purchasesales

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.

レスポンス

200A page of price lists.

itemsarray of PriceListSummary必須

Items in this page. Default ordering is by id ascending; see the resource’s list endpoint description for any per-resource overrides.

プロパティを表示

idintegerminimum 0, maximum 2147483647必須

Price list id.

namestring必須

Price list display name.

order_typestring必須

"purchase" for purchase price lists; "sales" for sales price lists. A price list is tied to one order type.

指定可能な値purchasesales

currency_codestringnullable必須

ISO 4217 currency code, or null when unset.

created_atstringdate-time必須

Server-side creation timestamp.

updated_atstringdate-time必須

Last edit timestamp, or the creation timestamp when never edited.

countintegerminimum 0, maximum 9007199254740991必須

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

limitintegerminimum 0, maximum 9007199254740991必須

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullable必須

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

has_moreboolean必須

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 (default: id ascending).

401Missing or invalid API token.

idstring必須

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.

typestring必須

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

指定可能な値/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

titlestring必須

Human-readable summary of the error, in English.

correlationIDstring必須

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.

instancestring必須

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

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 /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

プロパティを表示

patharray of string | number必須

messagestring必須

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

idstring必須

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.

typestring必須

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

titlestring必須

Human-readable summary of the error, in English.

correlationIDstring必須

instancestring必須

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

errorsarray 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.

プロパティを表示

patharray of string | number必須

messagestring必須

リクエスト

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

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

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

レスポンス

{
  "items": [
    {
      "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"
    }
  ],
  "count": 1,
  "limit": 100,
  "cursor": 81023,
  "has_more": false
}

{
  "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/too-many-requests",
  "title": "Too many requests.",
  "instance": "/price-lists",
  "retryAfter": 60
}