コンテンツにスキップ

Price lists

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

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

例

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