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.

Đối tượng 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 2147483647bắt buộc

Bundle id.

namestringbắt buộc

Bundle display name.

skustringbắt buộc

Stock Keeping Unit. Unique within the team.

barcodestringbắt buộc

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

coststringbắt buộc

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

pricestringbắt buộc

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

photo_urlstringnullablebắt buộc

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

memostringbắt buộc

Free-text memo. Empty string when not set.

componentsarray of BundleComponentbắt buộc

Component list. Bundles cannot contain other bundles.

Hiển thị thuộc tính

itemExtendedItemEntitybắt buộc

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

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Item or bundle id.

namestringbắt buộc

Display name.

skustringbắt buộc

SKU. Empty string when unset.

barcodestringbắt buộc

Barcode. Empty string when unset.

deletedbooleanbắt buộc

Whether the underlying item or bundle is deleted.

quantitynumberbắt buộc

Quantity of this item required per bundle.

Ví dụ

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

Endpoint

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}