The Configuration Object

The configuration object represents a configured product (including all selected options) and is the main payload returned by DIVA events (e.g. add-to-basket, save).

It is a rich object with many fields that are only relevant for specific modules or internal UI use cases. This page focuses on the fields that are typically relevant for webshop integrations.

[WIP] Work in Progress

This documentation is currently under development. If you encounter any gaps, please contact your project manager at Crystal Design.

Structure

Most relevant information is contained within OrderSets and their OrderLines.
The fields below are based on the standard OrderLines structure.

note

Client-specific OrderLines are possible and can be structured to match the webshop’s expectations.

Common fields

Field	Example	Description	Required
DivaNr	DIVA-123456	The ID of the configuration	Yes
OrigProductId	HLxyllmbD	The ID of the product that was used to initialize the configurator	No (only if initalized by product)
DocumentVersion	3	The version of the configuration	Yes
DivaNrVersion	DIVA-123456-3	The ID and the version combined	Yes
SetImage	https://img.jpg	The 3D image of the configuration	No (only if 3D data exists)
Set2DImage	https://img.jpg	The 2D image of the configuration	Yes
ProductImage	https://img.jpg	The 3D image if it exists, otherwise the 2D image	Yes
ProductSetName	MyBed	The display name of the configured product	Yes
OrderSets[0].OrderLines	[...]	List of all configured items (main item + accessories) see OrderLines	-

OrderLines fields

OrderLines represent the individual items of the configuration (main product plus related items such as accessories).
The following fields are commonly used for webshop integrations.

Field	Example	Description	Required
BasketID	B123456	Line identifier. Can be used to relate other lines (e.g. accessories).	Yes
PosNr	1 / 1.1	Position number; sub-items can be represented as sub-positions (e.g. 1.1).	Yes
CatalogCodex	CHAIRS	Catalog reference for this line.	Yes
ArticleCodex	5862	Article/variant codex for this line.	Yes
Quantity	2	Quantity for this line.	Yes
Name	MyBed	Display name of the item/line.	Yes
VariantDesc	...	Human-readable configuration description	Yes
RetailArticleNr	123-ABC	The article ID/SKU in the retailer’s system.	Yes
Width	200	Width	Yes
Depth	180	Depth	Yes
Height	110	Height	Yes
VKPrice.Price	999.0	Unit price	No (if DIVA displays prices)
VariantBasketDatas	[...]	List of selected option/value pairs for this line, see Variant values	No (if DIVA displays prices)

Variant values (VariantBasketDatas)

Configurations also contain the selected options/values for a line in VariantBasketDatas.

Field	Example	Description	Required
OPT	OPT_COLOR	Option identifier.	YES
OPV	OPV_BLUE	Option value identifier.	YES
OPTName	Color	Option display label.	No
OPVName	Blue	Option value display label.	No

Note on the configuration ID / versioning

The DivaNr uniquely identifies a configuration.
Often it is used together with a version, either as separate DocumentVersion or as a combined string (DivaNrVersion).

Example: DIVA-12345-2 represents version 2 of configuration DIVA-12345.