Bundles

Bundles — fixed groups of existing items, each with a set quantity, that can be sold or purchased together as a single line item.

Bundles have no stock of their own; inventory is tracked at the component-item level, and processing a bundle in an order adjusts each component’s stock accordingly.

ออบเจ็กต์ Bundle

A bundle with its component items. Bundles have no stock of their own; inventory is tracked at the component-item level.

idintegerminimum 0, maximum 2147483647จำเป็น

Bundle id.

namestringจำเป็น

Bundle display name.

skustringจำเป็น

Stock Keeping Unit. Unique within the team.

barcodestringจำเป็น

Primary barcode for the bundle. Empty string when not assigned.

coststringจำเป็น

Cost per bundle, as a decimal string. Independent from component item costs.

pricestringจำเป็น

Selling price per bundle, as a decimal string. Independent from component item prices.

photo_urlstringnullableจำเป็น

URL of the bundle photo. null when no photo is set.

memostringจำเป็น

Free-text memo. Empty string when not set.

componentsarray of BundleComponentจำเป็น

Component list. Bundles cannot contain other bundles.

แสดงพร็อพเพอร์ตี

itemExtendedItemEntityจำเป็น

Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

แสดงพร็อพเพอร์ตี

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.

quantitynumberจำเป็น

Quantity of this item required per bundle.

ตัวอย่าง

{
  "id": 4042,
  "name": "Starter Kit",
  "sku": "BUNDLE-STARTER",
  "barcode": "8801234567890",
  "cost": "12.50",
  "price": "29.99",
  "photo_url": null,
  "memo": "",
  "count_of_components": 2,
  "components": [
    {
      "item": {
        "id": 14290445,
        "name": "Finish Setting Powder",
        "sku": "SKU-12345678",
        "barcode": "2097678335587",
        "deleted": false
      },
      "quantity": 1
    },
    {
      "item": {
        "id": 14290446,
        "name": "Hydrating Face Toner",
        "sku": "SKU-12345679",
        "barcode": "2097678335588",
        "deleted": false
      },
      "quantity": 2
    }
  ]
}

เอนด์พอยต์

List bundles GET /v1/bundles
Create a bundle POST /v1/bundles
Get a bundle GET /v1/bundles/{bundle_id}
Update a bundle PUT /v1/bundles/{bundle_id}
Delete a bundle DELETE /v1/bundles/{bundle_id}
Get a bundle by SKU GET /v1/bundles/by-sku/{sku}
Update a bundle by SKU PUT /v1/bundles/by-sku/{sku}
Delete a bundle by SKU DELETE /v1/bundles/by-sku/{sku}