Ir al contenido

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 2147483647obligatorio

Price list id.

namestringobligatorio

Price list display name.

order_typestringobligatorio

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

Valores posiblespurchasesales

currency_codestringnullableobligatorio

ISO 4217 currency code, or null when unset.

created_atstringdate-timeobligatorio

Server-side creation timestamp.

updated_atstringdate-timeobligatorio

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

itemsarray of PriceListItemobligatorio

Line items, ordered by rank ascending.

Mostrar propiedades
itemExtendedItemEntitynullableobligatorio

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

Mostrar propiedades
idintegerminimum 0, maximum 2147483647obligatorio

Item or bundle id.

namestringobligatorio

Display name.

skustringobligatorio

SKU. Empty string when unset.

barcodestringobligatorio

Barcode. Empty string when unset.

deletedbooleanobligatorio

Whether the underlying item or bundle is deleted.

bundleExtendedItemEntitynullableobligatorio

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

Mostrar propiedades
idintegerminimum 0, maximum 2147483647obligatorio

Item or bundle id.

namestringobligatorio

Display name.

skustringobligatorio

SKU. Empty string when unset.

barcodestringobligatorio

Barcode. Empty string when unset.

deletedbooleanobligatorio

Whether the underlying item or bundle is deleted.

pricestringobligatorio

Unit price stored on this line.

rankintegerminimum -9007199254740991, maximum 9007199254740991obligatorio

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

Ejemplo

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