Get a price list

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

Each item references either an item or a bundle.

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

인증

Authorizationstring필수

Bearer <token> 형식의 Bearer 인증 헤더입니다. <token>에는 API 토큰을 넣습니다.

경로 파라미터

price_list_idintegerminimum 0, maximum 2147483647필수

Price list id.

응답

200The requested price list.

itemPriceList필수

A price list with its line items.

하위 속성 보기

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.

itemsarray of PriceListItem필수

Line items, ordered by rank ascending.

하위 속성 보기

itemExtendedItemEntitynullable필수

Set when this line references a single item; null for bundle lines.

하위 속성 보기

idintegerminimum 0, maximum 2147483647필수

Item or bundle id.

namestring필수

Display name.

skustring필수

SKU. Empty string when unset.

barcodestring필수

Barcode. Empty string when unset.

deletedboolean필수

Whether the underlying item or bundle is deleted.

bundleExtendedItemEntitynullable필수

Set when this line references a bundle; null for item lines.

하위 속성 보기

idintegerminimum 0, maximum 2147483647필수

Item or bundle id.

namestring필수

Display name.

skustring필수

SKU. Empty string when unset.

barcodestring필수

Barcode. Empty string when unset.

deletedboolean필수

Whether the underlying item or bundle is deleted.

pricestring필수

Unit price stored on this line.

rankintegerminimum -9007199254740991, maximum 9007199254740991필수

Line position within the price list (0-based).

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필수

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

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필수

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/{price_list_id}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"

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();

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()

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

응답 예시

{
  "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
      }
    ]
  }
}

{
  "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/not-found",
  "title": "No price list with the given id was found in this team.",
  "instance": "/price-lists/12345"
}

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