Products

List kit components

Gets the complete product BOM.

GET
/v1/products/{productId}/components

The BOM (bill of materials) describes which Variants are consumed to assemble one unit of this Product. Each component points to a Variant of the same Seller and records a whole-unit quantity. An empty list means the Product is not treated as a kit.

Use this read to explain derived quantity to a user. Example: if a kit consumes two cables and one charger, and there are 10 cables and 3 chargers available, at most 3 kits can be published — not 5.

The BOM does not move components or create reservations. It only defines the formula; query the Variant balance whose authority is derived to get calculated availability.

Authorization

api_key
headerAuthorizationBearer <token>

API key (mk_...)

Path Parameters

productId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

The complete product BOM, not paginated. Empty when the product is not a kit.

application/json
  1. response

The complete bill of materials of a product.

data*array<>

The complete BOM of the product; empty when it is not a kit.

Itemsitems <= 100
curl -X GET "https://example.com/v1/products/497f6eca-6276-4993-bfeb-53cbbbba6f08/components"
{  "data": [    {      "componentVariantId": "47c9f819-fcf6-4478-b21a-678ecc594a11",      "quantity": 2    }  ]}