Price lists

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

ออบเจ็กต์ PriceList

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

เอนด์พอยต์

List price lists GET /v1/price-lists
Create a price list POST /v1/price-lists
Get a price list GET /v1/price-lists/{price_list_id}
Update a price list PUT /v1/price-lists/{price_list_id}
Delete a price list DELETE /v1/price-lists/{price_list_id}