Skip to content
User Guide
English한국어DeutschEspañolFrançaisBahasa Indonesia日本語PortuguêsРусскийไทยTiếng Việt简体中文繁體中文

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.

The Bundle object

Section titled “The Bundle object”

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

idintegerminimum 0, maximum 2147483647required

Bundle id.

namestringrequired

Bundle display name.

skustringrequired

Stock Keeping Unit. Unique within the team.

barcodestringrequired

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

coststringrequired

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

pricestringrequired

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

photo_urlstringnullablerequired

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

memostringrequired

Free-text memo. Empty string when not set.

componentsarray of BundleComponentrequired

Component list. Bundles cannot contain other bundles.

Show properties
itemExtendedItemEntityrequired

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

Show properties
idintegerminimum 0, maximum 2147483647required

Item or bundle id.

namestringrequired

Display name.

skustringrequired

SKU. Empty string when unset.

barcodestringrequired

Barcode. Empty string when unset.

deletedbooleanrequired

Whether the underlying item or bundle is deleted.

quantitynumberrequired

Quantity of this item required per bundle.

Example

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

Endpoints

Section titled “Endpoints”