POST
Add components to a bundle
Company space For: Manager · Permission: bundle_components.create Conditions
  • The bundle must not be archived.
  • components is required with at least one entry; each stockable_id must be an active product-variant item of the organization, listed once.
  • Each unit must be active and belong to the component’s item.
  • A item that is already a component of the bundle is refused.
  • Components cannot be added while the bundle holds stock; detach the stock first.
  • A single stockable_id, stockable_unit_id or quantity at the top level is refused.
What else happens
  • Adds the components to the bundle’s recipe.
Part of Sell bundles and kits.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

bundle
string
required

Identifier of the bundle (27-character KSUID string).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, stockable_id, stockable_unit_id, quantity.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: variant, variant.vat_rate, variant.taxes, variant.image, variant.inventoryItem, variant.levels, variant.units, stockableUnit, stockableUnit.uomUnit, stockableUnit.prices, stockableUnit.stockable.

Response

Resource (only with response=resource).

data
BundleComponentResource · object[]
required

Items of this page.