ProductConfiguratorResult reference
This article provides reference material about ProductConfiguratorResult class
and its derived classes.
ProductConfiguratorResult class
ProductConfiguratorResult class is an abstract base class for product configurator result.
Product configurator extension has to return
an instance of ProductConfiguratorResult derived class when Sana calls
OnConfiguratorClientMessageReceivedAsync method.
Properties
ExternalConfigurationId
Gets the identifier of product(s) configuration result on configurator service's side.
This is a unique ID of this specific product configuration, done by the user, in external
configurator web site. Sana will use it as a session ID, so that when the user needs to
edit this specific product configuration later in time, Sana will pass this value
in GetConfiguratorUrlAsync method of the extension add-on.
SingleProductConfiguratorResult
SingleProductConfiguratorResult class represents the product configurator result
that is used when single product is the actual result of the configuration.
When the user configures a product on configurator web site's side, the result of this configuration may be a single product (newly created on the fly by the configurator web site in ERP, or existing product in ERP).
For example, the user starts configuring a product called "T-Shirt" with ID "T_SHIRT".
The external configurator web site is opened in an iframe by Sana, and the user
configures the product to their choice in it. When the user is finished with it,
the external configurator web site creates a new product (or picks up existing one) in the
ERP that matches the user's choice, with
"T_SHIRT_COLOR_GREEN_SIZE_XL_PRINT_42" ID and called "Green T-Shirt, Size XL, Print #42".
This product will be the result that needs to be returned to Sana, encapsulated in
SingleProductConfiguratorResult instance.
Properties
Product
Gets the instance of ConfiguredProduct class which is the actual result of the configuration which needs to be added to the basket.
ProductListConfiguratorResult
ProductListConfiguratorResult class represents the product configurator result,
that is used when multiple products are the actual result of the configuration.
When the user configures a product on configurator web site's side, the result of this configuration may be a list of products (newly created on the fly by the configurator web site in ERP, or existing products in ERP).
For example, the user starts configuring a product called "Picnic Cutlery Kit" with ID "PICNIC_CUTLERY_KIT".
The external configurator web site is opened in an iframe by Sana, and the user configures the products
to their choice in it. When the user is finished with it, the external configurator web site creates a new
list of products (or picks up existing ones) in the ERP that matches the user's choice, with "PLASTIC_SPOON_LARGE"
ID called "Large Size Plastic Spoon", "PLASTIC_KNIFE_MEDIUM" ID called "Medium Size Plastic Knife" and
"PLASTIC_FORK_MEDIUM" ID called "Medium Size Plastic Fork". This list of products will be the result that
needs to be returned to Sana, encapsulated in ProductListConfiguratorResult instance.
Properties
GroupTitle
Gets or sets the group title for the list of products.
Products
Gets the read-only list of ConfiguredProduct class which is the actual result of the configuration which needs to be added to the basket.
Quantity
Gets or sets the group quantity for the whole list of the products. The list is added to basket as one group, this quantity specifies how many of these product lists are added to the basket.