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.

El objeto 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 2147483647obligatorio

Bundle id.

namestringobligatorio

Bundle display name.

skustringobligatorio

Stock Keeping Unit. Unique within the team.

barcodestringobligatorio

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

coststringobligatorio

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

pricestringobligatorio

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

photo_urlstringnullableobligatorio

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

memostringobligatorio

Free-text memo. Empty string when not set.

componentsarray of BundleComponentobligatorio

Component list. Bundles cannot contain other bundles.

Mostrar propiedades

itemExtendedItemEntityobligatorio

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

Mostrar propiedades

idintegerminimum 0, maximum 2147483647obligatorio

Item or bundle id.

namestringobligatorio

Display name.

skustringobligatorio

SKU. Empty string when unset.

barcodestringobligatorio

Barcode. Empty string when unset.

deletedbooleanobligatorio

Whether the underlying item or bundle is deleted.

quantitynumberobligatorio

Quantity of this item required per bundle.

Ejemplo

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

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}