BOM

BOM stands for "Bill Of Material". It's a set JSON object containing the description of the current project, with the data required for an "Add to cart" action for example.

Event name	Input / Output	Payload	Reason
getBom	Input event	None.	Request the BOM for the current state.
bom	Output event	See the description below.	Receive the requested BOM.

Example

// Receive the BOM.
configurator.addEventListener("bom", (event) => {
    console.log(event.detail);
});

// Send a request to get the BOM.
configurator.dispatchEvent(new CustomEvent("getBom"))

Payload description

The BOM is a complex JSON object. At the top level, it contains the following attributes:

Attribute name	Type	Content
packs	Array of BOM object data. 🔗	If some pack were detected in the BOM, they will appear here.
products	Array of BOM object data. 🔗	This will contain the product currently loaded.
totalPrice	The Total price data. 🔗	This object contains the total price of the current product.

BOM Object data

This is the description of a product or sub product.

Attribute name	Type	Content
children	Array of BOM object data. 🔗	Sub products of this product.
clientMetadata	any	Client metadata for this product.
commercialDescription	string	Commercial description.
dbID	string	Identifier of this product in the database. If you load the same product multiple times, the dbid will be the same.
endDate	string?	End date of the product availability (timestamp).
freeTags	Array of string	Array of free tags associated to the furniture.
isExpired	boolean	True if the product was expired at the time of BOM generation.
name	string	Product name.
packs	Array of BOM object data. 🔗	See packs description. 🔗
priceExtra	number	An optional value to add to the price. All values are valid, even negative one (to reduce the total price).
priceMultiplier	number	A multiplier to apply to the price. It should be >= 0. 0 would put all prices to 0.
reference	string	Product reference.
shortDescription	string?	Short description of the product.
startDate	string?	Start date of the product availability (timestamp).
thumbnailURLSmall	string?	Product thumbnail (size 64).
typeID	number	Product closed tag ID of the product.
uuid	string	A unique random identifier for this instance of the product.

Total price data

This is the description of the total price of the current product.

Attribute name	Type	Content
currency	string	The currency to use, a 3 letters string following ISO 4217 🔗
regular	number	The computed regular price.
current	number	The computed current price. Can be the same as the regular price.
discountType	string	The discount type of the current price. "regular", "reduced", "discounted" or "membership"
startDate	string?	Optional. The date at which this price starts being available.
endDate	string?	Optional. The date at which this price availability ends.

Note: The start and end date format should follow the Date time string format. 🔗

Packs

If some products are bought by packs, like "A box of two sofa legs", they will appear in the "packs" attribute. Their description will contain the same data found in a BOM object 🔗, with those additional attributes:

Attribute name	Type	Content
quantity	number	Number of packs products needed for the project