PUT
Change a component quantity
Company space For: Manager · Permission: bundle_components.update Conditions
  • The bundle must not be archived.
  • quantity is required and must be at least 1; only the quantity can change, so a component’s stockable_id and stockable_unit_id are refused.
  • A component cannot be changed while the bundle holds stock.
What else happens
  • Changes the quantity of the component in the 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).

component
string
required

Identifier of the bundle component, which must belong to the bundle in the path (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).

id

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

stockable_id

Identifier of the component's item, a product variant.

stockable_unit_id

Identifier of the unit in which the quantity is expressed.

quantity
integer

Quantity of this component in one bundle, in the unit given by stockable_unit_id.

variant
object | null

The product variant behind the component; null when the item is not a variant.

stockable_unit
object | null

The unit of the component, with its unit of measure.