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}