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.

Das Bundle-Objekt

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

idintegerminimum 0, maximum 2147483647erforderlich

Bundle id.

namestringerforderlich

Bundle display name.

skustringerforderlich

Stock Keeping Unit. Unique within the team.

barcodestringerforderlich

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

coststringerforderlich

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

pricestringerforderlich

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

photo_urlstringnullableerforderlich

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

memostringerforderlich

Free-text memo. Empty string when not set.

componentsarray of BundleComponenterforderlich

Component list. Bundles cannot contain other bundles.

Eigenschaften anzeigen

itemExtendedItemEntityerforderlich

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

Eigenschaften anzeigen

idintegerminimum 0, maximum 2147483647erforderlich

Item or bundle id.

namestringerforderlich

Display name.

skustringerforderlich

SKU. Empty string when unset.

barcodestringerforderlich

Barcode. Empty string when unset.

deletedbooleanerforderlich

Whether the underlying item or bundle is deleted.

quantitynumbererforderlich

Quantity of this item required per bundle.

Beispiel

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

Endpunkte

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}