GraphQL API reference
API reference for the application-service which is used to load VELUX products data.
Contact
Responsible for this whole GraphQL API thing is Arvid Schönberg, reach out to him via mail!
API Endpoints
# Local (DDEV):
http://velux-application-service.ddev.site/api/gql
# Staging:
http://application.velux.argonauten.kitchen/api/gql
Queries
categories
Description
A query for loading multiple categories by passing filter data.
Response
Returns
[Category]
Arguments
| Name | Description |
|---|---|
parent_id -
ID
|
The parent ID of all categories to be loaded. |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
Example
Query
query categories(
$parent_id: ID,
$locale: String,
$country: String
) {
categories(
parent_id: $parent_id,
locale: $locale,
country: $country
) {
children {
...CategoryFragment
}
id
level
name
parent {
...CategoryFragment
}
pimId
products {
...ProductFragment
}
productsCount
type
}
}
Variables
{
"parent_id": 4,
"locale": "abc123",
"country": "abc123"
}
Response
{
"data": {
"categories": [
{
"children": [Category],
"id": 4,
"level": 123,
"name": "abc123",
"parent": Category,
"pimId": "xyz789",
"products": [Product],
"productsCount": 123,
"type": "xyz789"
}
]
}
}
category
Description
A query for loading a single category.
Response
Returns a
Category
Arguments
| Name | Description |
|---|---|
id -
ID
|
The ID to load the category with. |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
Example
Query
query category(
$id: ID,
$locale: String,
$country: String
) {
category(
id: $id,
locale: $locale,
country: $country
) {
children {
...CategoryFragment
}
id
level
name
parent {
...CategoryFragment
}
pimId
products {
...ProductFragment
}
productsCount
type
}
}
Variables
{
"id": "4",
"locale": "abc123",
"country": "xyz789"
}
Response
{
"data": {
"category": {
"children": [Category],
"id": "4",
"level": 987,
"name": "xyz789",
"parent": Category,
"pimId": "abc123",
"products": [Product],
"productsCount": 123,
"type": "xyz789"
}
}
}
collection
Description
A query for loading a single collection.
Response
Returns a
Collection
Arguments
| Name | Description |
|---|---|
id -
[ID]
|
A list of application-service-internal product IDs (e.g. [123, 456]). |
vci -
[String]
|
A list of VCI (Velux Code Internal) to load the collection's products with (e.g. ["GGL MK06 207021AU", "GGL MK08 207021A"]). Because the VCI is unique by definition, the list of resulting products in the collection is expected to contain only as many products as VCIs have been passed to the query or less than that (in case of invalid/unknown VCIs). |
vce -
[String]
|
A list of VCE (Velux Code External) to load the collection's products with (e.g. ["GGL MK06 217021", "GGL MK08 207021"]). Be aware that the VCE by definition isn't uniuqe in the VELUX world, because multiple VCIs might share the same VCE. Thus the number of resulting products is potentially higher than the number of passed VCEs. Consider passing in a vci instead. |
ean -
[String]
|
A list of EAN (European Article Number) to load the collection's products with (e.g. ["5702327187420"]). Be aware that the EAN by definition isn't uniuqe in the VELUX world, because multiple VCIs might share the same EAN. Thus the number of resulting products is potentially higher than the number of passed EANs. Consider passing in a vci instead. |
generation -
[String]
|
A list of product generations to load the collection's products with (e.g. ["V21", "V22"]). This field cannot be combined with generationId, use either one or another, but not both in a single query. |
generationId -
[Int]
|
A list of application-service-internal generation IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with generation, use either one or another, but not both in a single query. |
type -
[String]
|
A list of types (as being part of the VCE) to load the collection's products with (e.g. ["GGU", "GDL"]). This field cannot be combined with typeId, use either one or another, but not both in a single query. |
typeId -
[Int]
|
A list of application-service-internal type IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with type, use either one or another, but not both in a single query. |
size -
[String]
|
A list of sizes (as being part of the VCE) to load the collection's products with (e.g. ["MK06", "PK08"]). This field cannot be combined with sizeId, use either one or another, but not both in a single query. |
sizeId -
[Int]
|
A list of application-service-internal size IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with size, use either one or another, but not both in a single query. |
interior -
[String]
|
A list of interiors (as being part of the VCE) to load the collection's products with (e.g. ["0", "2"]). This field cannot be combined with interiorId, use either one or another, but not both in a single query. |
interiorId -
[Int]
|
A list of application-service-internal interior IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with interior, use either one or another, but not both in a single query. |
exterior -
[String]
|
A list of exteriors (as being part of the VCE) to load the collection's products with (e.g. ["0", "1"]). This field cannot be combined with exteriorId, use either one or another, but not both in a single query. |
exteriorId -
[Int]
|
A list of application-service-internal exterior IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with exterior, use either one or another, but not both in a single query. |
glazing -
[String]
|
A list of glazings (as being part of the VCE) to load the collection's products with (e.g. ["70", "68"]). This field cannot be combined with glazingId, use either one or another, but not both in a single query. |
glazingId -
[Int]
|
A list of application-service-internal glazing IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with glazing, use either one or another, but not both in a single query. |
operation -
[String]
|
A list of operations (as being part of the VCE) to load the collection's products with (e.g. ["21", "30"]). You can also pass operation: [null] in case you want to exclude any products that do have an operation part in their VCI/VCE and to only retrieve those products without specific operational features at all. Or in other words: While 21 and 30 stand for electric and solar powered, null stands for manual operation or fixed (no further destinction possible). This field cannot be combined with operationId, use either one or another, but not both in a single query. |
operationId -
[Int]
|
A list of application-service-internal operation IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with operation, use either one or another, but not both in a single query. |
dessin -
[String]
|
A list of dessin codes (as being part of the VCE) to load the collection's products with (e.g. ["1085", "4556", "CBYS"]). This field cannot be combined with dessinId, use either one or another, but not both in a single query. |
dessinId -
[Int]
|
A list of application-service-internal dessin IDs to filter the collection's products by (e.g. [123, 456, 789]). This field cannot be combined with dessin, use either one or another, but not both in a single query. |
siderailcolorId -
[Int]
|
A list of application-service-internal siderailcolor IDs to filter the collection's products by (e.g. [123, 456, 789]). |
length -
[String]
|
A list of length codes to filter the collection's products by (e.g. ["CK", "FK", "M"]). This field cannot be combined with lengthId, use either one or another, but not both in a single query. |
lengthId -
[ID]
|
A list of application-service-internal length IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with length, use either one or another, but not both in a single query. |
height -
[String]
|
A list of height codes to filter the collection's products by (e.g. ["04", "06", "25"]). This field cannot be combined with heightId, use either one or another, but not both in a single query. |
heightId -
[ID]
|
A list of application-service-internal height IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with height, use either one or another, but not both in a single query. |
hinging -
[String]
|
A list of hinging names to filter the collection's products by (e.g. ["The sash pivots horizontally at its centre.", "The openable sash pivots horizontally at its centre."]). This field cannot be combined with hingingId, use either one or another, but not both in a single query. |
hingingId -
[ID]
|
A list of application-service-internal hinging IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with hinging, use either one or another, but not both in a single query. |
addon -
[String]
|
A list of addon descriptions or additional products to filter the collection's products by. This field cannot be combined with addonId, use either one or another, but not both in a single query. |
addonId -
[ID]
|
A list of application-service-internal addon IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with addon, use either one or another, but not both in a single query. |
roofThickness -
[String]
|
A list of roof thicknesses to filter the collection's products by (e.g. ["300 mm", "500 mm"]). This field cannot be combined with roofThicknessId, use either one or another, but not both in a single query. |
roofThicknessId -
[ID]
|
A list of application-service-internal roof thickness IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with roofThickness, use either one or another, but not both in a single query. |
flange -
[String]
|
A list of flange values to filter the collection's products by (e.g. ["With flange", "Without flange"]). This field cannot be combined with flangeId, use either one or another, but not both in a single query. |
flangeId -
[ID]
|
A list of application-service-internal flange IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with flange, use either one or another, but not both in a single query. |
domeColor -
[String]
|
A list of dome color names to filter the collection's products by (e.g. ["Dome acrylic, clear", "Dome polycarbonate, opaque"]). This field cannot be combined with domeColorId, use either one or another, but not both in a single query. |
domeColorId -
[ID]
|
A list of application-service-internal dome color IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with domeColor, use either one or another, but not both in a single query. |
domeLayer -
[String]
|
A list of dome layer names to filter the collection's products by (e.g. ["2-layer dome", "3-layer dome"]). This field cannot be combined with domeLayerId, use either one or another, but not both in a single query. |
domeLayerId -
[ID]
|
A list of application-service-internal dome layer IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with domeLayer, use either one or another, but not both in a single query. |
domeKerbHeight -
[String]
|
A list of dome kerb heights to filter the collection's products by (e.g. ["15 cm", "50 cm"]). This field cannot be combined with domeKerbHeightId, use either one or another, but not both in a single query. |
domeKerbHeightId -
[ID]
|
A list of application-service-internal dome kerb height IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with domeKerbHeight, use either one or another, but not both in a single query. |
category -
[String]
|
A list of category names to filter the collection's products by (e.g. ["Type GPL", "Type GGL"] or also category names of higher levels are possible as well like ["Centre-pivot", "Top-hung"]). |
categoryId -
[ID]
|
A list of application-service-internal category IDs to filter the collection's products by (e.g. [123, 456]). |
categoryPimId -
[String]
|
A list of category PIM-IDs to filter the collection's products by (e.g. ["ProductCategory-386454-2", "ProductLine-18324832-1"]). |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
search -
String
|
A search term to find the collection products with. Will trigger a simple full-text search additionally to all other query arguments being passed. |
compatibleWith -
[String]
|
A list of product VCI codes that the collection's products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithId -
[Int]
|
A list of application-service-internal product IDs that the collection's products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductType -
[String]
|
A list of product type codes that the collection's products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductTypeId -
[Int]
|
A list of application-service-internal product type IDs that the collection's products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductCategory -
[String]
|
A list of product categories that the collection's products to be loaded have to be compatible with (e.g. ["GGL 66, Pro-delivery", "GGL 62, extra sound reduction"]). Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductCategoryId -
[Int]
|
A list of application-service-internal product category IDs that the collection's products to be loaded have to be compatible with (e.g. [123, 456]). Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductCategoryPimId -
[String]
|
A list of category PIM-IDs that the collection's products to be loaded have to be compatible with (e.g. ["Product-37155000-1", "Product-137873-2"]). Don't use this argument together with one of the combinableWith… arguments. |
compatibilityType -
CompatibilityType
|
The compatibility type to filter the collection's products by how they're related to the product they are compatible with. This parameter only makes sense in combination with compatibleWith and compatibleWithId. Don't use this argument together with one of the combinableWith… arguments or with combinationType. |
combinableWith -
[String]
|
A list of product VCI codes that the collection's products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinableWithId -
[Int]
|
A list of application-service-internal product IDs that the collection's products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinableWithProductType -
[String]
|
A list of product type codes that the collection's products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinableWithProductTypeId -
[Int]
|
A list of application-service-internal product type IDs that the collection's products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinationType -
CombinationType
|
The combination type to filter the collection's products by how they're related to the product they are combinable with. This parameter only makes sense in combination with combinableWith and combinableWithId. Don't use this argument together with one of the compatibleWith… arguments or with compatibilityType. |
professionalsProductProgram -
Boolean
|
Filters the collections's products by those that are in the professional products program. If omitted then any products will be loaded and returned with the response regardless of their isProfessionalsProductProgram value. Passing false will exclude all professionals products (to load only those products having set their isProfessionalsProductProgram flag to false) and passing true will load only professionals products (products having set their isProfessionalsProductProgram flag to true). |
isBom -
Boolean
|
Filters the collection's products by those that are BOM products. If omitted then any products will be loaded and returned with the response regardless of their isBom value. Passing false will exclude all BOM products (to load only those products having set their isBom flag to false) and passing true will load only BOM products (products having set their isBom flag to true). |
status -
[Int]
|
Filters the collections's products by their status. If omitted then only available products will be loaded. Available products are all of which have one of the following status values: 64, 65, 66, 67, 68, 69, 70, 71 or NULL. You can pass [72] to load only products that are closed for sales, for instance. |
gutterWidthVertical -
[String]
|
A list of vertical gutter widths to filter the collection's products by (e.g. ["18 mm", "100 mm"]). This field cannot be combined with gutterWidthVerticalId, use either one or another, but not both in a single query. |
gutterWidthVerticalId -
[ID]
|
A list of application-service-internal vertical gutter width IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with gutterWidthVertical, use either one or another, but not both in a single query. |
gutterWidthHorizontal -
[String]
|
A list of horizontal gutter widths to filter the collection's products by (e.g. ["0 mm", "250 mm"]). This field cannot be combined with gutterWidthHorizontalId, use either one or another, but not both in a single query. |
gutterWidthHorizontalId -
[ID]
|
A list of application-service-internal horizontal gutter width IDs to filter the collection's products by (e.g. [123, 456]). This field cannot be combined with gutterWidthHorizontal, use either one or another, but not both in a single query. |
db -
String
|
Sets the database connection for accessing the collection data. Be aware that the passed value is not expected to be a database name but rather the connection name (e.g. "mysql", "mysql2"). |
Example
Query
query collection(
$id: [ID],
$vci: [String],
$vce: [String],
$ean: [String],
$generation: [String],
$generationId: [Int],
$type: [String],
$typeId: [Int],
$size: [String],
$sizeId: [Int],
$interior: [String],
$interiorId: [Int],
$exterior: [String],
$exteriorId: [Int],
$glazing: [String],
$glazingId: [Int],
$operation: [String],
$operationId: [Int],
$dessin: [String],
$dessinId: [Int],
$siderailcolorId: [Int],
$length: [String],
$lengthId: [ID],
$height: [String],
$heightId: [ID],
$hinging: [String],
$hingingId: [ID],
$addon: [String],
$addonId: [ID],
$roofThickness: [String],
$roofThicknessId: [ID],
$flange: [String],
$flangeId: [ID],
$domeColor: [String],
$domeColorId: [ID],
$domeLayer: [String],
$domeLayerId: [ID],
$domeKerbHeight: [String],
$domeKerbHeightId: [ID],
$category: [String],
$categoryId: [ID],
$categoryPimId: [String],
$country: String,
$locale: String,
$search: String,
$compatibleWith: [String],
$compatibleWithId: [Int],
$compatibleWithProductType: [String],
$compatibleWithProductTypeId: [Int],
$compatibleWithProductCategory: [String],
$compatibleWithProductCategoryId: [Int],
$compatibleWithProductCategoryPimId: [String],
$compatibilityType: CompatibilityType,
$combinableWith: [String],
$combinableWithId: [Int],
$combinableWithProductType: [String],
$combinableWithProductTypeId: [Int],
$combinationType: CombinationType,
$professionalsProductProgram: Boolean,
$isBom: Boolean,
$status: [Int],
$gutterWidthVertical: [String],
$gutterWidthVerticalId: [ID],
$gutterWidthHorizontal: [String],
$gutterWidthHorizontalId: [ID],
$db: String
) {
collection(
id: $id,
vci: $vci,
vce: $vce,
ean: $ean,
generation: $generation,
generationId: $generationId,
type: $type,
typeId: $typeId,
size: $size,
sizeId: $sizeId,
interior: $interior,
interiorId: $interiorId,
exterior: $exterior,
exteriorId: $exteriorId,
glazing: $glazing,
glazingId: $glazingId,
operation: $operation,
operationId: $operationId,
dessin: $dessin,
dessinId: $dessinId,
siderailcolorId: $siderailcolorId,
length: $length,
lengthId: $lengthId,
height: $height,
heightId: $heightId,
hinging: $hinging,
hingingId: $hingingId,
addon: $addon,
addonId: $addonId,
roofThickness: $roofThickness,
roofThicknessId: $roofThicknessId,
flange: $flange,
flangeId: $flangeId,
domeColor: $domeColor,
domeColorId: $domeColorId,
domeLayer: $domeLayer,
domeLayerId: $domeLayerId,
domeKerbHeight: $domeKerbHeight,
domeKerbHeightId: $domeKerbHeightId,
category: $category,
categoryId: $categoryId,
categoryPimId: $categoryPimId,
country: $country,
locale: $locale,
search: $search,
compatibleWith: $compatibleWith,
compatibleWithId: $compatibleWithId,
compatibleWithProductType: $compatibleWithProductType,
compatibleWithProductTypeId: $compatibleWithProductTypeId,
compatibleWithProductCategory: $compatibleWithProductCategory,
compatibleWithProductCategoryId: $compatibleWithProductCategoryId,
compatibleWithProductCategoryPimId: $compatibleWithProductCategoryPimId,
compatibilityType: $compatibilityType,
combinableWith: $combinableWith,
combinableWithId: $combinableWithId,
combinableWithProductType: $combinableWithProductType,
combinableWithProductTypeId: $combinableWithProductTypeId,
combinationType: $combinationType,
professionalsProductProgram: $professionalsProductProgram,
isBom: $isBom,
status: $status,
gutterWidthVertical: $gutterWidthVertical,
gutterWidthVerticalId: $gutterWidthVerticalId,
gutterWidthHorizontal: $gutterWidthHorizontal,
gutterWidthHorizontalId: $gutterWidthHorizontalId,
db: $db
) {
addons {
...AddonFragment
}
categories {
...CategoryFragment
}
dessins {
...DessinFragment
}
domeKerbHeights {
...DomeKerbHeightFragment
}
domeLayers {
...DomeLayerFragment
}
domeColors {
...DomeColorFragment
}
exteriors {
...ExteriorFragment
}
flanges {
...FlangeFragment
}
glazings {
...GlazingFragment
}
gutterWidthVerticals {
...GutterWidthVerticalFragment
}
gutterWidthHorizontals {
...GutterWidthHorizontalFragment
}
heights {
...HeightFragment
}
hingings {
...HingingFragment
}
interiors {
...InteriorFragment
}
lengths {
...LengthFragment
}
minPrice {
...PriceFragment
}
operations {
...OperationFragment
}
products {
...ProductFragment
}
productsCount
roofThicknesses {
...RoofThicknessFragment
}
siderailcolors {
...SiderailcolorFragment
}
sizes {
...SizeFragment
}
types {
...TypeFragment
}
_sql
_sqlBindings
_sqlBindingsJson
}
}
Variables
{
"id": [4],
"vci": ["abc123"],
"vce": ["abc123"],
"ean": ["abc123"],
"generation": ["xyz789"],
"generationId": [123],
"type": ["abc123"],
"typeId": [987],
"size": ["abc123"],
"sizeId": [987],
"interior": ["xyz789"],
"interiorId": [123],
"exterior": ["abc123"],
"exteriorId": [987],
"glazing": ["abc123"],
"glazingId": [987],
"operation": ["xyz789"],
"operationId": [987],
"dessin": ["xyz789"],
"dessinId": [987],
"siderailcolorId": [987],
"length": ["abc123"],
"lengthId": ["4"],
"height": ["abc123"],
"heightId": [4],
"hinging": ["abc123"],
"hingingId": ["4"],
"addon": ["abc123"],
"addonId": ["4"],
"roofThickness": ["abc123"],
"roofThicknessId": [4],
"flange": ["xyz789"],
"flangeId": ["4"],
"domeColor": ["abc123"],
"domeColorId": ["4"],
"domeLayer": ["xyz789"],
"domeLayerId": [4],
"domeKerbHeight": ["xyz789"],
"domeKerbHeightId": [4],
"category": ["abc123"],
"categoryId": [4],
"categoryPimId": ["xyz789"],
"country": "abc123",
"locale": "abc123",
"search": "xyz789",
"compatibleWith": ["xyz789"],
"compatibleWithId": [987],
"compatibleWithProductType": ["xyz789"],
"compatibleWithProductTypeId": [987],
"compatibleWithProductCategory": [
"abc123"
],
"compatibleWithProductCategoryId": [987],
"compatibleWithProductCategoryPimId": [
"xyz789"
],
"compatibilityType": "DSP",
"combinableWith": ["xyz789"],
"combinableWithId": [987],
"combinableWithProductType": ["xyz789"],
"combinableWithProductTypeId": [987],
"combinationType": "ROOF_BALCONY_OR_SLOPED_EXTENSION",
"professionalsProductProgram": false,
"isBom": true,
"status": [987],
"gutterWidthVertical": ["abc123"],
"gutterWidthVerticalId": [4],
"gutterWidthHorizontal": ["xyz789"],
"gutterWidthHorizontalId": [4],
"db": "xyz789"
}
Response
{
"data": {
"collection": {
"addons": [Addon],
"categories": [Category],
"dessins": [Dessin],
"domeKerbHeights": [DomeKerbHeight],
"domeLayers": [DomeLayer],
"domeColors": [DomeColor],
"exteriors": [Exterior],
"flanges": [Flange],
"glazings": [Glazing],
"gutterWidthVerticals": [GutterWidthVertical],
"gutterWidthHorizontals": [GutterWidthHorizontal],
"heights": [Height],
"hingings": [Hinging],
"interiors": [Interior],
"lengths": [Length],
"minPrice": Price,
"operations": [Operation],
"products": [Product],
"productsCount": 987,
"roofThicknesses": [RoofThickness],
"siderailcolors": [Siderailcolor],
"sizes": [Size],
"types": [Type],
"_sql": "xyz789",
"_sqlBindings": ["xyz789"],
"_sqlBindingsJson": "abc123"
}
}
}
combination
Description
A query to load a specific product combination.
Response
Returns a
Combination
Arguments
| Name | Description |
|---|---|
id -
ID
|
An application-service internal database ID of a specific product combination. Will always be prioritized when combined with other arguments such as productId or vci, the latter ones will always be ignored in case of an id is passed. |
productId -
[ID]
|
A list of application-service internal database IDs of combinable products. |
vci -
[String]
|
A list of VCIs of combinable products.
Sidenote: Any given VCI will be checked for availability in the current market, therefore only that combination will be returned whose products do both exist and are available in the country that has been passed to the query. |
combinationType -
CombinationType
|
The type of combination. (optional, but recommended, e.g. "roof_balcony_or_sloped_extension", "vertical_extension") |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
status -
[Int]
|
Filters the products by their status. If omitted then only available products will be loaded. Available products are all of which have one of the following status values: 64, 65, 66, 67, 68, 69, 70, 71 or NULL. You can pass [72] to load only products that are closed for sales, for instance. |
db -
String
|
Sets the database connection for accessing the product data. Be aware that the passed value is not expected to be a database name but rather the connection name (e.g. "mysql", "mysql2"). |
Example
Query
query combination(
$id: ID,
$productId: [ID],
$vci: [String],
$combinationType: CombinationType,
$locale: String,
$country: String,
$status: [Int],
$db: String
) {
combination(
id: $id,
productId: $productId,
vci: $vci,
combinationType: $combinationType,
locale: $locale,
country: $country,
status: $status,
db: $db
) {
id
products {
...CombinableProductFragment
}
solutions {
...SolutionProductFragment
}
solutionsId
solutionsVci
type
}
}
Variables
{
"id": 4,
"productId": ["4"],
"vci": ["abc123"],
"combinationType": "ROOF_BALCONY_OR_SLOPED_EXTENSION",
"locale": "xyz789",
"country": "xyz789",
"status": [987],
"db": "abc123"
}
Response
{
"data": {
"combination": {
"id": "4",
"products": [CombinableProduct],
"solutions": [SolutionProduct],
"solutionsId": "xyz789",
"solutionsVci": "xyz789",
"type": "xyz789"
}
}
}
combinationSolutions
Description
A query for loading the available solution products for a specific product combination either by passing the combined product's application-service's internal database IDs or their VELUX-internal codes (VCIs).
Response
Returns
[SolutionProduct]
Arguments
| Name | Description |
|---|---|
id -
[ID]
|
A list of application-service internal database IDs of combined products to get the solutions for. (required, either that one or else pass a vci, if passed both then the VCI will be ignored in favor of the ID)
Minor caveat: Any given ID won't be checked for availability in the current market. |
vci -
[String]
|
A list of VCIs of combined products to get the solutions for. (required, either that one or else pass an id, if passed both then the VCI will be ignored in favor of the ID)
Sidenote: Any given VCI will be checked for availability in the current market, therefore only those solutions will be returned for combinations whose products do both exist and are available in the country that has been passed to the query. |
combinationType -
CombinationType
|
The type of combination. (optional, but recommended, e.g. "roof_balcony_or_sloped_extension") |
solutionType -
SolutionType
|
The type of solutions. (required, e.g. "flashing_solutions") |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
status -
[Int]
|
Filters the products by their status. If omitted then only available products will be loaded. Available products are all of which have one of the following status values: 64, 65, 66, 67, 68, 69, 70, 71 or NULL. You can pass [72] to load only products that are closed for sales, for instance. |
db -
String
|
Sets the database connection for accessing the product data. Be aware that the passed value is not expected to be a database name but rather the connection name (e.g. "mysql", "mysql2"). |
Example
Query
query combinationSolutions(
$id: [ID],
$vci: [String],
$combinationType: CombinationType,
$solutionType: SolutionType,
$locale: String,
$country: String,
$status: [Int],
$db: String
) {
combinationSolutions(
id: $id,
vci: $vci,
combinationType: $combinationType,
solutionType: $solutionType,
locale: $locale,
country: $country,
status: $status,
db: $db
) {
addon {
...AddonFragment
}
airPermeability
availableAddons {
...ProductVariantFragment
}
availableDessins {
...ProductVariantFragment
}
availableDomeColors {
...ProductVariantFragment
}
availableDomeKerbHeights {
...ProductVariantFragment
}
availableDomeLayers {
...ProductVariantFragment
}
availableExteriors {
...ProductVariantFragment
}
availableFlanges {
...ProductVariantFragment
}
availableGlazings {
...ProductVariantFragment
}
availableHeights {
...ProductVariantFragment
}
availableHingings {
...ProductVariantFragment
}
availableInteriors {
...ProductVariantFragment
}
availableLengths {
...ProductVariantFragment
}
availableOperations {
...ProductVariantFragment
}
availableProductVariants {
...ProductVariantFragment
}
availableRoofThicknesses {
...ProductVariantFragment
}
availableGutterWidthVerticals {
...ProductVariantFragment
}
availableGutterWidthHorizontals {
...ProductVariantFragment
}
availableSiderailcolors {
...ProductVariantFragment
}
availableSizes {
...ProductVariantFragment
}
availableTypes {
...ProductVariantFragment
}
bomProducts {
...ProductFragment
}
categories {
...CategoryFragment
}
category {
...CategoryFragment
}
combinable {
...CombinableProductsFragment
}
combinationSolutions {
...SolutionProductFragment
}
compatible {
...CompatibleProductFragment
}
deliveryTime
description
descriptionLong
dessin {
...DessinFragment
}
domeColor {
...DomeColorFragment
}
domeKerbHeight {
...DomeKerbHeightFragment
}
domeLayer {
...DomeLayerFragment
}
ean
effectiveDaylightArea {
...AreaFragment
}
exterior {
...ExteriorFragment
}
flange {
...FlangeFragment
}
frwCombinations {
...FrwCombinationFragment
}
generation {
...ProductGenerationFragment
}
glazing {
...GlazingFragment
}
gutterWidthVertical {
...GutterWidthVerticalFragment
}
gutterWidthHorizontal {
...GutterWidthHorizontalFragment
}
height {
...HeightFragment
}
hinging {
...HingingFragment
}
id
imagePrimary {
...ImageFragment
}
imagesSecondary {
...ImageFragment
}
interior {
...InteriorFragment
}
isBom
isBurglaryResistant
isEligible
isProDelivery
isProfessionalsProductProgram
length {
...LengthFragment
}
longCommercialDescription
longCommercialName
marketIntroduction
materialDescription
name
nameLong
operation {
...OperationFragment
}
price {
...PriceFragment
}
prices {
...PriceFragment
}
roofThickness {
...RoofThicknessFragment
}
searchData
searchTerms
shortCommercialDescription
shortCommercialName
siderailcolor {
...SiderailcolorFragment
}
size {
...SizeFragment
}
soundInsulation
status
thermalTransmittance
totalSolarEnergyTransmittance
translations {
...TranslationFragment
}
type {
...TypeFragment
}
vce
vci
additionallyRequired {
...ProductFragment
}
additionallyRequiredId
}
}
Variables
{
"id": [4],
"vci": ["abc123"],
"combinationType": "ROOF_BALCONY_OR_SLOPED_EXTENSION",
"solutionType": "LINING_SOLUTIONS",
"locale": "xyz789",
"country": "abc123",
"status": [123],
"db": "xyz789"
}
Response
{
"data": {
"combinationSolutions": [
{
"addon": Addon,
"airPermeability": 987,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [
ProductVariant
],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 987,
"description": "xyz789",
"descriptionLong": "abc123",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "abc123",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": "4",
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": false,
"isBurglaryResistant": false,
"isEligible": false,
"isProDelivery": false,
"isProfessionalsProductProgram": true,
"length": Length,
"longCommercialDescription": "xyz789",
"longCommercialName": "abc123",
"marketIntroduction": "abc123",
"materialDescription": "xyz789",
"name": "xyz789",
"nameLong": "abc123",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "abc123",
"searchTerms": ["abc123"],
"shortCommercialDescription": "abc123",
"shortCommercialName": "abc123",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "xyz789",
"status": 987,
"thermalTransmittance": "abc123",
"totalSolarEnergyTransmittance": 987.65,
"translations": [Translation],
"type": Type,
"vce": "xyz789",
"vci": "xyz789",
"additionallyRequired": [Product],
"additionallyRequiredId": [4]
}
]
}
}
compatibility
Description
A query to load a specific product compatibility.
Response
Returns a
Compatibility
Arguments
| Name | Description |
|---|---|
id -
ID
|
An application-service internal database ID of a specific product compatibility. Will always be prioritized when combined with other arguments such as productId or vci, the latter ones will always be ignored in case of an id is passed. |
productId -
[ID]
|
A list of application-service internal database IDs of compatible products. |
vci -
[String]
|
A list of VCIs of compatible products.
Sidenote: Any given VCI will be checked for availability in the current market, therefore only that compatibility will be returned whose products do both exist and are available in the country that has been passed to the query. |
compatibilityType -
CompatibilityType
|
The type of compatibility. (optional, but recommended, e.g. "blinds_and_shutters", "flashings") |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
status -
[Int]
|
Filters the products by their status. If omitted then only available products will be loaded. Available products are all of which have one of the following status values: 64, 65, 66, 67, 68, 69, 70, 71 or NULL. You can pass [72] to load only products that are closed for sales, for instance. |
db -
String
|
Sets the database connection for accessing the product data. Be aware that the passed value is not expected to be a database name but rather the connection name (e.g. "mysql", "mysql2"). |
Example
Query
query compatibility(
$id: ID,
$productId: [ID],
$vci: [String],
$compatibilityType: CompatibilityType,
$locale: String,
$country: String,
$status: [Int],
$db: String
) {
compatibility(
id: $id,
productId: $productId,
vci: $vci,
compatibilityType: $compatibilityType,
locale: $locale,
country: $country,
status: $status,
db: $db
) {
id
products {
...CompatibleProductFragment
}
type
additionallyRequired {
...ProductFragment
}
additionallyRequiredId
additionallyRequiredVci
}
}
Variables
{
"id": 4,
"productId": ["4"],
"vci": ["abc123"],
"compatibilityType": "DSP",
"locale": "abc123",
"country": "abc123",
"status": [987],
"db": "abc123"
}
Response
{
"data": {
"compatibility": {
"id": "4",
"products": [CompatibleProduct],
"type": "abc123",
"additionallyRequired": [Product],
"additionallyRequiredId": "xyz789",
"additionallyRequiredVci": "abc123"
}
}
}
frwCombination
Description
A query for loading a specific FRW combination by given products.
Response
Returns a
FrwCombination
Arguments
| Name | Description |
|---|---|
frwCombinationId -
ID
|
The application-service-internal database ID of a specific FRW combination. |
id -
[ID]
|
A list of application-service-internal product IDs (e.g. [123, 456]). |
vci -
[String]
|
A list of VCI (Velux Code Internal) to load the FRW combination with (e.g. ["CFU 090060 0025Q", "ISU 090060 1093"]). |
ean -
[String]
|
A list of EAN (European Article Number) to load the combination with (e.g. ["5702329187169", "5702329187008"]). |
db -
String
|
Sets the database connection for accessing the combination data. Be aware that the passed value is not expected to be a database name but rather the connection name (e.g. "mysql", "mysql2"). |
Example
Query
query frwCombination(
$frwCombinationId: ID,
$id: [ID],
$vci: [String],
$ean: [String],
$db: String
) {
frwCombination(
frwCombinationId: $frwCombinationId,
id: $id,
vci: $vci,
ean: $ean,
db: $db
) {
airPermeability
arcRef300
bondingOfCoverGlass
burglarResistanceWindow
externalFirePerformanceBritish
externalFirePerformanceEuropean
frameFactor
id
impactResistance
impactResistanceLargeSoftBody
impactResistanceSmallHardBody
lightTransmittanceIgu
loadBearingCapacityOfSafety
name
objectName
pimId
products {
...ProductFragment
}
rainNoise
reactionToFire
resistanceToDownwardLoad
resistanceToFireIgu
resistanceToSnowLoadFrw
resistanceToSnowLoadIgu
resistanceToUpwardLoad
resistanceToWindLoad
soundInsulation
thermalLinearHeatLossIgu
thermalLinearHeatLossIguCalc
thermalLinearLossBuiltin
thermalLinearLossBuiltinCalc
thermalTransmittanceCenterOgHorizontal
thermalTransmittanceCogVertical
thermalTransmittanceFrameSashCalc
thermalTransmittanceHorizontal
thermalTransmittanceSurfaceAreaNotCe
thermalTransmittanceUrc
totalSolarEnergyTransmittanceIgu
ultravioletTransmittanceIgu
waterTightness
}
}
Variables
{
"frwCombinationId": 4,
"id": ["4"],
"vci": ["xyz789"],
"ean": ["xyz789"],
"db": "xyz789"
}
Response
{
"data": {
"frwCombination": {
"airPermeability": "xyz789",
"arcRef300": "abc123",
"bondingOfCoverGlass": "abc123",
"burglarResistanceWindow": "xyz789",
"externalFirePerformanceBritish": "xyz789",
"externalFirePerformanceEuropean": "abc123",
"frameFactor": "abc123",
"id": 4,
"impactResistance": "xyz789",
"impactResistanceLargeSoftBody": "abc123",
"impactResistanceSmallHardBody": "xyz789",
"lightTransmittanceIgu": "abc123",
"loadBearingCapacityOfSafety": "abc123",
"name": "xyz789",
"objectName": "xyz789",
"pimId": "abc123",
"products": [Product],
"rainNoise": "xyz789",
"reactionToFire": "xyz789",
"resistanceToDownwardLoad": "abc123",
"resistanceToFireIgu": "xyz789",
"resistanceToSnowLoadFrw": "xyz789",
"resistanceToSnowLoadIgu": "abc123",
"resistanceToUpwardLoad": "abc123",
"resistanceToWindLoad": "xyz789",
"soundInsulation": "xyz789",
"thermalLinearHeatLossIgu": "abc123",
"thermalLinearHeatLossIguCalc": "abc123",
"thermalLinearLossBuiltin": "xyz789",
"thermalLinearLossBuiltinCalc": "abc123",
"thermalTransmittanceCenterOgHorizontal": "abc123",
"thermalTransmittanceCogVertical": "xyz789",
"thermalTransmittanceFrameSashCalc": "xyz789",
"thermalTransmittanceHorizontal": "xyz789",
"thermalTransmittanceSurfaceAreaNotCe": "abc123",
"thermalTransmittanceUrc": "xyz789",
"totalSolarEnergyTransmittanceIgu": "abc123",
"ultravioletTransmittanceIgu": "xyz789",
"waterTightness": "abc123"
}
}
}
product
Description
A query for loading a single product by its application-service's internal database ID or by its VELUX-internal code (the VCI).
Response
Returns a
Product
Arguments
| Name | Description |
|---|---|
id -
ID
|
The application-service's internal database ID to load the product with. Consider passing in a vci instead in case you do not know anything about the database IDs. |
vci -
String
|
The VCI (Velux Code Internal) to load the product with (e.g. GGL MK08 207021A). Be aware that when passing in both, an id and a vci then the id is prioritized for querying the database. Thus rather use only one of both arguments only. |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
db -
String
|
Sets the database connection for accessing the product data. Be aware that the passed value is not expected to be a database name but rather the connection name (e.g. "mysql", "mysql2"). |
Example
Query
query product(
$id: ID,
$vci: String,
$locale: String,
$country: String,
$db: String
) {
product(
id: $id,
vci: $vci,
locale: $locale,
country: $country,
db: $db
) {
addon {
...AddonFragment
}
airPermeability
availableAddons {
...ProductVariantFragment
}
availableDessins {
...ProductVariantFragment
}
availableDomeColors {
...ProductVariantFragment
}
availableDomeKerbHeights {
...ProductVariantFragment
}
availableDomeLayers {
...ProductVariantFragment
}
availableExteriors {
...ProductVariantFragment
}
availableFlanges {
...ProductVariantFragment
}
availableGlazings {
...ProductVariantFragment
}
availableHeights {
...ProductVariantFragment
}
availableHingings {
...ProductVariantFragment
}
availableInteriors {
...ProductVariantFragment
}
availableLengths {
...ProductVariantFragment
}
availableOperations {
...ProductVariantFragment
}
availableProductVariants {
...ProductVariantFragment
}
availableRoofThicknesses {
...ProductVariantFragment
}
availableGutterWidthVerticals {
...ProductVariantFragment
}
availableGutterWidthHorizontals {
...ProductVariantFragment
}
availableSiderailcolors {
...ProductVariantFragment
}
availableSizes {
...ProductVariantFragment
}
availableTypes {
...ProductVariantFragment
}
bomProducts {
...ProductFragment
}
categories {
...CategoryFragment
}
category {
...CategoryFragment
}
combinable {
...CombinableProductsFragment
}
combinationSolutions {
...SolutionProductFragment
}
compatible {
...CompatibleProductFragment
}
deliveryTime
description
descriptionLong
dessin {
...DessinFragment
}
domeColor {
...DomeColorFragment
}
domeKerbHeight {
...DomeKerbHeightFragment
}
domeLayer {
...DomeLayerFragment
}
ean
effectiveDaylightArea {
...AreaFragment
}
exterior {
...ExteriorFragment
}
flange {
...FlangeFragment
}
frwCombinations {
...FrwCombinationFragment
}
generation {
...ProductGenerationFragment
}
glazing {
...GlazingFragment
}
gutterWidthVertical {
...GutterWidthVerticalFragment
}
gutterWidthHorizontal {
...GutterWidthHorizontalFragment
}
height {
...HeightFragment
}
hinging {
...HingingFragment
}
id
imagePrimary {
...ImageFragment
}
imagesSecondary {
...ImageFragment
}
interior {
...InteriorFragment
}
isBom
isBurglaryResistant
isEligible
isProDelivery
isProfessionalsProductProgram
length {
...LengthFragment
}
longCommercialDescription
longCommercialName
marketIntroduction
materialDescription
name
nameLong
operation {
...OperationFragment
}
price {
...PriceFragment
}
prices {
...PriceFragment
}
roofThickness {
...RoofThicknessFragment
}
searchData
searchTerms
shortCommercialDescription
shortCommercialName
siderailcolor {
...SiderailcolorFragment
}
size {
...SizeFragment
}
soundInsulation
status
thermalTransmittance
totalSolarEnergyTransmittance
translations {
...TranslationFragment
}
type {
...TypeFragment
}
vce
vci
}
}
Variables
{
"id": "4",
"vci": "xyz789",
"locale": "abc123",
"country": "xyz789",
"db": "xyz789"
}
Response
{
"data": {
"product": {
"addon": Addon,
"airPermeability": 123,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [ProductVariant],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 987,
"description": "xyz789",
"descriptionLong": "xyz789",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "xyz789",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": "4",
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": false,
"isBurglaryResistant": false,
"isEligible": true,
"isProDelivery": false,
"isProfessionalsProductProgram": false,
"length": Length,
"longCommercialDescription": "abc123",
"longCommercialName": "abc123",
"marketIntroduction": "abc123",
"materialDescription": "abc123",
"name": "abc123",
"nameLong": "abc123",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "abc123",
"searchTerms": ["abc123"],
"shortCommercialDescription": "xyz789",
"shortCommercialName": "xyz789",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "abc123",
"status": 987,
"thermalTransmittance": "abc123",
"totalSolarEnergyTransmittance": 987.65,
"translations": [Translation],
"type": Type,
"vce": "xyz789",
"vci": "abc123"
}
}
}
products
Description
A query for loading multiple products, optionally by filtering and paginating them.
Response
Returns
[Product]
Arguments
| Name | Description |
|---|---|
limit -
Int
|
The max. number of products to be loaded. To offset the result-set respectively for paginated results pass in page as another argument. Omitting the limit is the same as passing in 100 which is the default. |
page -
Int
|
The n-th sub-set of products being loaded. → Or in other words: It's for controlling the pagination of queried products. Omitting the page is the same as passing in 1 to get the first sub-set. To control the "size" (or max. number of products) for each page use in combination with limit being passed as another argument. |
id -
[ID]
|
A list of application-service-internal product IDs (e.g. [123, 456]). |
vci -
[String]
|
A list of VCI (Velux Code Internal) to load the products with (e.g. ["GGL MK06 207021AU", "GGL MK08 207021A"]). Because the VCI is unique by definition, the list of resulting products is expected to contain only as many products as VCIs have been passed to the query or less than that (in case of invalid/unknown VCIs). |
vce -
[String]
|
A list of VCE (Velux Code External) to load the products with (e.g. ["GGL MK06 217021", "GGL MK08 207021"]). Be aware that the VCE by definition isn't uniuqe in the VELUX world, because multiple VCIs might share the same VCE. Thus the number of resulting products is potentially higher than the number of passed VCEs. Consider passing in a vci instead. |
ean -
[String]
|
A list of EAN (European Article Number) to load the products with (e.g. ["5702327187420"]). Be aware that the EAN by definition isn't uniuqe in the VELUX world, because multiple VCIs might share the same EAN. Thus the number of resulting products is potentially higher than the number of passed EANs. Consider passing in a vci instead. |
generation -
[String]
|
A list of product generations to load the products with (e.g. ["V21", "V22"]). This field cannot be combined with generationId, use either one or another, but not both in a single query. |
generationId -
[Int]
|
A list of application-service-internal generation IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with generation, use either one or another, but not both in a single query. |
type -
[String]
|
A list of types (as being part of the VCE) to load the products with (e.g. ["GGU", "GDL"]). This field cannot be combined with the field type_id, use either one or another, but not both in a single query. |
typeId -
[Int]
|
A list of application-service-internal type IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with the field type, use either one or another, but not both in a single query. |
size -
[String]
|
A list of sizes (as being part of the VCE) to load the products with (e.g. ["MK06", "PK08"]). This field cannot be combined with the field size_id, use either one or another, but not both in a single query. |
sizeId -
[Int]
|
A list of application-service-internal size IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with the field size, use either one or another, but not both in a single query. |
interior -
[String]
|
A list of interiors (as being part of the VCE) to load the products with (e.g. ["0", "2"]). This field cannot be combined with the field interior_id, use either one or another, but not both in a single query. |
interiorId -
[Int]
|
A list of application-service-internal interior IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with the field interior, use either one or another, but not both in a single query. |
exterior -
[String]
|
A list of exteriors (as being part of the VCE) to load the products with (e.g. ["0", "1"]). This field cannot be combined with the field exterior_id, use either one or another, but not both in a single query. |
exteriorId -
[Int]
|
A list of application-service-internal exterior IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with the field exterior, use either one or another, but not both in a single query. |
glazing -
[String]
|
A list of glazings (as being part of the VCE) to load the products with (e.g. ["70", "68"]). This field cannot be combined with the field glazing_id, use either one or another, but not both in a single query. |
glazingId -
[Int]
|
A list of application-service-internal glazing IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with the field glazing, use either one or another, but not both in a single query. |
operation -
[String]
|
A list of operations (as being part of the VCE) to load the products with (e.g. ["21", "30"]). You can also pass operation: [null] in case you want to exclude any products that do have an operation part in their VCI/VCE and to only retrieve those products without specific operational features at all. Or in other words: While 21 and 30 stand for electric and solar powered, null stands for manual operation or fixed (no further destinction possible). This field cannot be combined with the field operation_id, use either one or another, but not both in a single query. |
operationId -
[Int]
|
A list of application-service-internal operation IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with the field operation, use either one or another, but not both in a single query. |
dessin -
[String]
|
A list of dessin codes (as being part of the VCE) to load the products with (e.g. ["1085", "4556", "CBYS"]). This field cannot be combined with the field dessin_id, use either one or another, but not both in a single query. |
dessinId -
[Int]
|
A list of application-service-internal dessin IDs to filter the products by (e.g. [123, 456, 789]). This field cannot be combined with the field dessin, use either one or another, but not both in a single query. |
siderailcolorId -
[Int]
|
A list of application-service-internal siderailcolor IDs to filter the products by (e.g. [123, 456, 789]). |
length -
[String]
|
A list of length codes to filter the products by (e.g. ["CK", "FK", "M"]). This field cannot be combined with lengthId, use either one or another, but not both in a single query. |
lengthId -
[ID]
|
A list of application-service-internal length IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with length, use either one or another, but not both in a single query. |
height -
[String]
|
A list of height codes to filter the products by (e.g. ["04", "06", "25"]). This field cannot be combined with heightId, use either one or another, but not both in a single query. |
heightId -
[ID]
|
A list of application-service-internal height IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with height, use either one or another, but not both in a single query. |
hinging -
[String]
|
A list of hinging names to filter the products by (e.g. ["The sash pivots horizontally at its centre.", "The openable sash pivots horizontally at its centre."]). This field cannot be combined with hingingId, use either one or another, but not both in a single query. |
hingingId -
[ID]
|
A list of application-service-internal hinging IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with hinging, use either one or another, but not both in a single query. |
addon -
[String]
|
A list of addon descriptions or additional products to filter the products by. This field cannot be combined with addonId, use either one or another, but not both in a single query. |
addonId -
[ID]
|
A list of application-service-internal addon IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with addon, use either one or another, but not both in a single query. |
roofThickness -
[String]
|
A list of roof thicknesses to filter the products by (e.g. ["300 mm", "500 mm"]). This field cannot be combined with roofThicknessId, use either one or another, but not both in a single query. |
roofThicknessId -
[ID]
|
A list of application-service-internal roof thickness IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with roofThickness, use either one or another, but not both in a single query. |
gutterWidthVertical -
[String]
|
A list of vertical gutter widths to filter the products by (e.g. ["18 mm", "100 mm"]). This field cannot be combined with gutterWidthVerticalId, use either one or another, but not both in a single query. |
gutterWidthVerticalId -
[ID]
|
A list of application-service-internal vertical gutter width IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with gutterWidthVertical, use either one or another, but not both in a single query. |
gutterWidthHorizontal -
[String]
|
A list of horizontal gutter widths to filter the products by (e.g. ["0 mm", "250 mm"]). This field cannot be combined with gutterWidthHorizontalId, use either one or another, but not both in a single query. |
gutterWidthHorizontalId -
[ID]
|
A list of application-service-internal horizontal gutter width IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with gutterWidthHorizontal, use either one or another, but not both in a single query. |
flange -
[String]
|
A list of flange values to filter the products by (e.g. ["With flange", "Without flange"]). This field cannot be combined with flangeId, use either one or another, but not both in a single query. |
flangeId -
[ID]
|
A list of application-service-internal flange IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with flange, use either one or another, but not both in a single query. |
domeColor -
[String]
|
A list of dome color names to filter the products by (e.g. ["Dome acrylic, clear", "Dome polycarbonate, opaque"]). This field cannot be combined with domeColorId, use either one or another, but not both in a single query. |
domeColorId -
[ID]
|
A list of application-service-internal dome color IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with domeColor, use either one or another, but not both in a single query. |
domeLayer -
[String]
|
A list of dome layer names to filter the products by (e.g. ["2-layer dome", "3-layer dome"]). This field cannot be combined with domeLayerId, use either one or another, but not both in a single query. |
domeLayerId -
[ID]
|
A list of application-service-internal dome layer IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with domeLayer, use either one or another, but not both in a single query. |
domeKerbHeight -
[String]
|
A list of dome kerb heights to filter the products by (e.g. ["15 cm", "50 cm"]). This field cannot be combined with domeKerbHeightId, use either one or another, but not both in a single query. |
domeKerbHeightId -
[ID]
|
A list of application-service-internal dome kerb height IDs to filter the products by (e.g. [123, 456]). This field cannot be combined with domeKerbHeight, use either one or another, but not both in a single query. |
category -
[String]
|
A list of category names to filter the products by (e.g. ["Type GPL", "Type GGL"] or also category names of higher levels are possible as well like ["Centre-pivot", "Top-hung"]). |
categoryId -
[ID]
|
A list of application-service-internal category IDs to filter the products by (e.g. [123, 456]). |
categoryPimId -
[String]
|
A list of PIM-internal category IDs to filter the products by (e.g. ["ProductGroup-1418-0", "ProductLine-18324832-1"]). |
country -
String
|
Sets the country code (e.g. DE, CH) to be used request-wide for the whole current GQL query. This country code will be applied to any field that localized market data has to be loaded for. Defaults to HQ if omitted, unless a locale is given. In case of a locale is passed to the query the country is extracted from that one. This country argument is only used for overriding the country as being part of the passed locale, so to speak. |
locale -
String
|
Sets the locale (e.g. de-DE, fr-CH) to be used request-wide for the whole current GQL query. This locale will be applied to any localized market data being loaded as well es to any string field that a translation exists for. Defaults to en-HQ if omitted. |
search -
String
|
A search term to find the products with. Will trigger a simple full-text search additionally to all other query arguments being passed. |
compatibleWith -
[String]
|
A list of product VCI codes that the products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithId -
[Int]
|
A list of application-service-internal product IDs that the products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductType -
[String]
|
A list of product type codes that the products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductTypeId -
[Int]
|
A list of application-service-internal product type IDs that the products to be loaded have to be compatible with. Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductCategory -
[String]
|
A list of product categories that the products to be loaded have to be compatible with (e.g. ["GGL 66, Pro-delivery", "GGL 62, extra sound reduction"]). Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductCategoryId -
[Int]
|
A list of application-service-internal product category IDs that the products to be loaded have to be compatible with (e.g. [123, 456]). Don't use this argument together with one of the combinableWith… arguments. |
compatibleWithProductCategoryPimId -
[String]
|
A list of category PIM-IDs that the products to be loaded have to be compatible with (e.g. ["Product-37155000-1", "Product-137873-2"]). Don't use this argument together with one of the combinableWith… arguments. |
compatibilityType -
CompatibilityType
|
The compatibility type to filter the products by how they're related to the product they are compatible with. This parameter only makes sense in combination with compatibleWith and compatibleWithId. Don't use this argument together with one of the combinableWith… arguments or with combinationType. |
combinableWith -
[String]
|
A list of product VCI codes that the products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinableWithId -
[Int]
|
A list of application-service-internal product IDs that the products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinableWithProductType -
[String]
|
A list of product type codes that the products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinableWithProductTypeId -
[Int]
|
A list of application-service-internal product type IDs that the products to be loaded have to be combinable with. Don't use this argument together with one of the compatibleWith… arguments. |
combinationType -
CombinationType
|
The combination type to filter the products by how they're related to the product they are combinable with. This parameter only makes sense in combination with combinableWith and combinableWithId. Don't use this argument together with one of the compatibleWith… arguments or with compatibilityType. |
professionalsProductProgram -
Boolean
|
Filters the products by those that are in the professional products program. If omitted then any products will be loaded and returned with the response regardless of their isProfessionalsProductProgram value. Passing false will exclude all professionals products (products having set their isProfessionalsProductProgram flag to false) and passing true will load only them (products having set their isProfessionalsProductProgram flag to true). |
isBom -
Boolean
|
Filters the products by those that are BOM products. If omitted then any products will be loaded and returned with the response regardless of their isBom value. Passing false will exclude all BOM products (to load only those products having set their isBom flag to false) and passing true will load only BOM products (products having set their isBom flag to true). |
status -
[Int]
|
Filters the products by their status. If omitted then only available products will be loaded. Available products are all of which have one of the following status values: 64, 65, 66, 67, 68, 69, 70, 71 or NULL. You can pass [72] to load only products that are closed for sales, for instance. |
db -
String
|
Sets the database connection for accessing the products data. Be aware that the passed value is not expected to be a database name but rather the connection name (e.g. "mysql", "mysql2"). |
Example
Query
query products(
$limit: Int,
$page: Int,
$id: [ID],
$vci: [String],
$vce: [String],
$ean: [String],
$generation: [String],
$generationId: [Int],
$type: [String],
$typeId: [Int],
$size: [String],
$sizeId: [Int],
$interior: [String],
$interiorId: [Int],
$exterior: [String],
$exteriorId: [Int],
$glazing: [String],
$glazingId: [Int],
$operation: [String],
$operationId: [Int],
$dessin: [String],
$dessinId: [Int],
$siderailcolorId: [Int],
$length: [String],
$lengthId: [ID],
$height: [String],
$heightId: [ID],
$hinging: [String],
$hingingId: [ID],
$addon: [String],
$addonId: [ID],
$roofThickness: [String],
$roofThicknessId: [ID],
$gutterWidthVertical: [String],
$gutterWidthVerticalId: [ID],
$gutterWidthHorizontal: [String],
$gutterWidthHorizontalId: [ID],
$flange: [String],
$flangeId: [ID],
$domeColor: [String],
$domeColorId: [ID],
$domeLayer: [String],
$domeLayerId: [ID],
$domeKerbHeight: [String],
$domeKerbHeightId: [ID],
$category: [String],
$categoryId: [ID],
$categoryPimId: [String],
$country: String,
$locale: String,
$search: String,
$compatibleWith: [String],
$compatibleWithId: [Int],
$compatibleWithProductType: [String],
$compatibleWithProductTypeId: [Int],
$compatibleWithProductCategory: [String],
$compatibleWithProductCategoryId: [Int],
$compatibleWithProductCategoryPimId: [String],
$compatibilityType: CompatibilityType,
$combinableWith: [String],
$combinableWithId: [Int],
$combinableWithProductType: [String],
$combinableWithProductTypeId: [Int],
$combinationType: CombinationType,
$professionalsProductProgram: Boolean,
$isBom: Boolean,
$status: [Int],
$db: String
) {
products(
limit: $limit,
page: $page,
id: $id,
vci: $vci,
vce: $vce,
ean: $ean,
generation: $generation,
generationId: $generationId,
type: $type,
typeId: $typeId,
size: $size,
sizeId: $sizeId,
interior: $interior,
interiorId: $interiorId,
exterior: $exterior,
exteriorId: $exteriorId,
glazing: $glazing,
glazingId: $glazingId,
operation: $operation,
operationId: $operationId,
dessin: $dessin,
dessinId: $dessinId,
siderailcolorId: $siderailcolorId,
length: $length,
lengthId: $lengthId,
height: $height,
heightId: $heightId,
hinging: $hinging,
hingingId: $hingingId,
addon: $addon,
addonId: $addonId,
roofThickness: $roofThickness,
roofThicknessId: $roofThicknessId,
gutterWidthVertical: $gutterWidthVertical,
gutterWidthVerticalId: $gutterWidthVerticalId,
gutterWidthHorizontal: $gutterWidthHorizontal,
gutterWidthHorizontalId: $gutterWidthHorizontalId,
flange: $flange,
flangeId: $flangeId,
domeColor: $domeColor,
domeColorId: $domeColorId,
domeLayer: $domeLayer,
domeLayerId: $domeLayerId,
domeKerbHeight: $domeKerbHeight,
domeKerbHeightId: $domeKerbHeightId,
category: $category,
categoryId: $categoryId,
categoryPimId: $categoryPimId,
country: $country,
locale: $locale,
search: $search,
compatibleWith: $compatibleWith,
compatibleWithId: $compatibleWithId,
compatibleWithProductType: $compatibleWithProductType,
compatibleWithProductTypeId: $compatibleWithProductTypeId,
compatibleWithProductCategory: $compatibleWithProductCategory,
compatibleWithProductCategoryId: $compatibleWithProductCategoryId,
compatibleWithProductCategoryPimId: $compatibleWithProductCategoryPimId,
compatibilityType: $compatibilityType,
combinableWith: $combinableWith,
combinableWithId: $combinableWithId,
combinableWithProductType: $combinableWithProductType,
combinableWithProductTypeId: $combinableWithProductTypeId,
combinationType: $combinationType,
professionalsProductProgram: $professionalsProductProgram,
isBom: $isBom,
status: $status,
db: $db
) {
addon {
...AddonFragment
}
airPermeability
availableAddons {
...ProductVariantFragment
}
availableDessins {
...ProductVariantFragment
}
availableDomeColors {
...ProductVariantFragment
}
availableDomeKerbHeights {
...ProductVariantFragment
}
availableDomeLayers {
...ProductVariantFragment
}
availableExteriors {
...ProductVariantFragment
}
availableFlanges {
...ProductVariantFragment
}
availableGlazings {
...ProductVariantFragment
}
availableHeights {
...ProductVariantFragment
}
availableHingings {
...ProductVariantFragment
}
availableInteriors {
...ProductVariantFragment
}
availableLengths {
...ProductVariantFragment
}
availableOperations {
...ProductVariantFragment
}
availableProductVariants {
...ProductVariantFragment
}
availableRoofThicknesses {
...ProductVariantFragment
}
availableGutterWidthVerticals {
...ProductVariantFragment
}
availableGutterWidthHorizontals {
...ProductVariantFragment
}
availableSiderailcolors {
...ProductVariantFragment
}
availableSizes {
...ProductVariantFragment
}
availableTypes {
...ProductVariantFragment
}
bomProducts {
...ProductFragment
}
categories {
...CategoryFragment
}
category {
...CategoryFragment
}
combinable {
...CombinableProductsFragment
}
combinationSolutions {
...SolutionProductFragment
}
compatible {
...CompatibleProductFragment
}
deliveryTime
description
descriptionLong
dessin {
...DessinFragment
}
domeColor {
...DomeColorFragment
}
domeKerbHeight {
...DomeKerbHeightFragment
}
domeLayer {
...DomeLayerFragment
}
ean
effectiveDaylightArea {
...AreaFragment
}
exterior {
...ExteriorFragment
}
flange {
...FlangeFragment
}
frwCombinations {
...FrwCombinationFragment
}
generation {
...ProductGenerationFragment
}
glazing {
...GlazingFragment
}
gutterWidthVertical {
...GutterWidthVerticalFragment
}
gutterWidthHorizontal {
...GutterWidthHorizontalFragment
}
height {
...HeightFragment
}
hinging {
...HingingFragment
}
id
imagePrimary {
...ImageFragment
}
imagesSecondary {
...ImageFragment
}
interior {
...InteriorFragment
}
isBom
isBurglaryResistant
isEligible
isProDelivery
isProfessionalsProductProgram
length {
...LengthFragment
}
longCommercialDescription
longCommercialName
marketIntroduction
materialDescription
name
nameLong
operation {
...OperationFragment
}
price {
...PriceFragment
}
prices {
...PriceFragment
}
roofThickness {
...RoofThicknessFragment
}
searchData
searchTerms
shortCommercialDescription
shortCommercialName
siderailcolor {
...SiderailcolorFragment
}
size {
...SizeFragment
}
soundInsulation
status
thermalTransmittance
totalSolarEnergyTransmittance
translations {
...TranslationFragment
}
type {
...TypeFragment
}
vce
vci
}
}
Variables
{
"limit": 987,
"page": 123,
"id": ["4"],
"vci": ["xyz789"],
"vce": ["xyz789"],
"ean": ["xyz789"],
"generation": ["xyz789"],
"generationId": [123],
"type": ["xyz789"],
"typeId": [987],
"size": ["xyz789"],
"sizeId": [987],
"interior": ["xyz789"],
"interiorId": [123],
"exterior": ["xyz789"],
"exteriorId": [987],
"glazing": ["abc123"],
"glazingId": [987],
"operation": ["xyz789"],
"operationId": [987],
"dessin": ["abc123"],
"dessinId": [123],
"siderailcolorId": [123],
"length": ["xyz789"],
"lengthId": ["4"],
"height": ["abc123"],
"heightId": ["4"],
"hinging": ["xyz789"],
"hingingId": ["4"],
"addon": ["abc123"],
"addonId": ["4"],
"roofThickness": ["abc123"],
"roofThicknessId": [4],
"gutterWidthVertical": ["xyz789"],
"gutterWidthVerticalId": ["4"],
"gutterWidthHorizontal": ["xyz789"],
"gutterWidthHorizontalId": ["4"],
"flange": ["abc123"],
"flangeId": ["4"],
"domeColor": ["abc123"],
"domeColorId": [4],
"domeLayer": ["xyz789"],
"domeLayerId": ["4"],
"domeKerbHeight": ["xyz789"],
"domeKerbHeightId": ["4"],
"category": ["abc123"],
"categoryId": ["4"],
"categoryPimId": ["abc123"],
"country": "xyz789",
"locale": "xyz789",
"search": "abc123",
"compatibleWith": ["abc123"],
"compatibleWithId": [123],
"compatibleWithProductType": ["abc123"],
"compatibleWithProductTypeId": [123],
"compatibleWithProductCategory": [
"xyz789"
],
"compatibleWithProductCategoryId": [987],
"compatibleWithProductCategoryPimId": [
"xyz789"
],
"compatibilityType": "DSP",
"combinableWith": ["xyz789"],
"combinableWithId": [123],
"combinableWithProductType": ["xyz789"],
"combinableWithProductTypeId": [123],
"combinationType": "ROOF_BALCONY_OR_SLOPED_EXTENSION",
"professionalsProductProgram": false,
"isBom": true,
"status": [123],
"db": "xyz789"
}
Response
{
"data": {
"products": [
{
"addon": Addon,
"airPermeability": 123,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [
ProductVariant
],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 987,
"description": "abc123",
"descriptionLong": "abc123",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "abc123",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": 4,
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": false,
"isBurglaryResistant": false,
"isEligible": false,
"isProDelivery": false,
"isProfessionalsProductProgram": false,
"length": Length,
"longCommercialDescription": "abc123",
"longCommercialName": "abc123",
"marketIntroduction": "xyz789",
"materialDescription": "abc123",
"name": "xyz789",
"nameLong": "abc123",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "abc123",
"searchTerms": ["xyz789"],
"shortCommercialDescription": "abc123",
"shortCommercialName": "abc123",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "abc123",
"status": 123,
"thermalTransmittance": "abc123",
"totalSolarEnergyTransmittance": 987.65,
"translations": [Translation],
"type": Type,
"vce": "xyz789",
"vci": "abc123"
}
]
}
}
Types
Addon
Area
Description
An area as being the result of a length×width (or length×height).
Fields
| Field Name | Description |
|---|---|
sqcm -
Float
|
The area in square centimeters (cm²). |
Arguments
|
|
sqm -
Float
|
The area in square meters (m²). |
Arguments
|
|
sqmm -
Float
|
The area in square millimeters (mm²). |
Arguments
|
|
Example
{"sqcm": 987.65, "sqm": 987.65, "sqmm": 987.65}
Boolean
Description
The Boolean scalar type represents true or false.
Category
Description
A product category.
Fields
| Field Name | Description |
|---|---|
children -
[Category]
|
List of all direct sub-categories. Therefore the listing won't include grandchildren, great-grandchildren etc., you will have to ask the children for their children to get those. |
id -
ID!
|
The category's ID. |
level -
Int!
|
The category's hierarchy level, where the category tree's root node, the most-parent category so to speak (e.g. VRW) has level 1, direct descendants have level 2, their descendants have level 3 and so on. |
name -
String!
|
The category's name. |
parent -
Category
|
The parent category. |
pimId -
String!
|
The category's PIM-internal ID. It's unique by definition and will never change. |
products -
[Product]
|
List of products either directly related to the current category or indirectly related via any descendant categories. In other words: All products of this category as well as all products of its children and grandchildren and great-grandchildren etc. will be loaded. |
productsCount -
Int!
|
Total number of products either directly related to the current category or indirectly related via any descendant categories. |
type -
String!
|
The category's type which is one of category, family, group, line, type, product. |
Example
{
"children": [Category],
"id": "4",
"level": 987,
"name": "xyz789",
"parent": Category,
"pimId": "xyz789",
"products": [Product],
"productsCount": 123,
"type": "xyz789"
}
Collection
Description
A collections's data where collections can be anything from a single product category (and its set of underlying products, available sizes etc.) to a combination of multiple product categories with size and operation filters added (and its set of underlying data like the said products and availabilites for several specs).
Fields
| Field Name | Description |
|---|---|
addons -
[Addon]
|
The collection's available addons. |
categories -
[Category]
|
The collection's available product categories. |
dessins -
[Dessin]
|
The collection's available product dessins. |
domeKerbHeights -
[DomeKerbHeight]
|
The collection's available dome kerb heights. |
domeLayers -
[DomeLayer]
|
The collection's available dome layers. |
domeColors -
[DomeColor]
|
The collection's available dome colors. |
exteriors -
[Exterior]
|
The collection's available exterior finishes. |
flanges -
[Flange]
|
The collection's available flanges. |
glazings -
[Glazing]
|
The collection's available glazings. |
gutterWidthVerticals -
[GutterWidthVertical]
|
The collection's available vertical gutter widths. |
gutterWidthHorizontals -
[GutterWidthHorizontal]
|
The collection's available horizontal gutter widths. |
heights -
[Height]
|
The collection's available heights. |
hingings -
[Hinging]
|
The collection's available hingings. |
interiors -
[Interior]
|
The collection's available interior finishes. |
lengths -
[Length]
|
The collection's available lengths. |
minPrice -
Price
|
The collection's minimum price that can be found in all of its products for the current country as passed to the query. |
operations -
[Operation]
|
The collection's available product operations. Be aware that null is a valid operation being available, because operational features are not set in case of a window's usual operation type which is "manually" or also "fixed", they both aren't encoded in the VCI/VCE (like "electric" or "solar powered" are). |
products -
[Product]
|
The collection's products. |
productsCount -
Int
|
The collection's number of products. |
roofThicknesses -
[RoofThickness]
|
The collection's available roof thicknesses. |
siderailcolors -
[Siderailcolor]
|
The collection's available product siderailcolors. |
sizes -
[Size]
|
The collection's available product sizes. |
types -
[Type]
|
The collection's available product types. |
_sql -
String
|
The SQL query to load the products with. |
_sqlBindings -
[String]
|
The SQL query's bindings to load the products with as a list of strings. Beware that some strings might actually be of different type than string such as numeric or boolean. See also _sqlBindingsJson field to get the bindings data as a JSON formatted string. |
_sqlBindingsJson -
String
|
The SQL query's bindings to load the products with as JSON formatted string. |
Example
{
"addons": [Addon],
"categories": [Category],
"dessins": [Dessin],
"domeKerbHeights": [DomeKerbHeight],
"domeLayers": [DomeLayer],
"domeColors": [DomeColor],
"exteriors": [Exterior],
"flanges": [Flange],
"glazings": [Glazing],
"gutterWidthVerticals": [GutterWidthVertical],
"gutterWidthHorizontals": [GutterWidthHorizontal],
"heights": [Height],
"hingings": [Hinging],
"interiors": [Interior],
"lengths": [Length],
"minPrice": Price,
"operations": [Operation],
"products": [Product],
"productsCount": 987,
"roofThicknesses": [RoofThickness],
"siderailcolors": [Siderailcolor],
"sizes": [Size],
"types": [Type],
"_sql": "xyz789",
"_sqlBindings": ["xyz789"],
"_sqlBindingsJson": "xyz789"
}
CombinableProduct
Description
A product being compatible with another one through a "product combination" type of relation (such as dormers, roof balconies, roof terraces and vertical extensions).
Fields
| Field Name | Description |
|---|---|
addon -
Addon
|
The product's additional products (if set, otherwise null). |
airPermeability -
Int
|
The product's air permeability. |
availableAddons -
[ProductVariant]
|
The product's addon variants. List of product variants of different addon that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDessins -
[ProductVariant]
|
The product's dessin variants. List of product variants of different dessin that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeColors -
[ProductVariant]
|
The product's dome color variants ("clear" / "opaque" / etc.). List of product variants of different dome colors that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeKerbHeights -
[ProductVariant]
|
The product's dome heights variants. List of product variants of different dome heights that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeLayers -
[ProductVariant]
|
The product's dome layers variants. List of product variants of different dome layers that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableExteriors -
[ProductVariant]
|
The product's exterior variants. List of product variants of different exterior finish that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableFlanges -
[ProductVariant]
|
The product's flanges variants. List of product variants of different flanges that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGlazings -
[ProductVariant]
|
The product's glazing variants. List of product variants of different glazing that share the exact same other characteristics with the current product (same size, same interior finish, same exterior finish etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHeights -
[ProductVariant]
|
The product's height variants. List of product variants of different height that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of height variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHingings -
[ProductVariant]
|
The product's hinging variants. List of product variants of different hinging that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableInteriors -
[ProductVariant]
|
The product's interior variants. List of product variants of different interior finish that share the exact same other characteristics with the current product (same size, same exterior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableLengths -
[ProductVariant]
|
The product's length variants. List of product variants of different length that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of length variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableOperations -
[ProductVariant]
|
The product's operation variants. List of product variants of different operation that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableProductVariants -
[ProductVariant]
|
List of products sharing the exact same characteristics with the current product (e.g. same size, same interior finish, same glazing etc.), see argument same. Or in short: It's listing the product's variants dependant on given characteristics.
Be aware that this field requires you to pass in a country code or a locale to the query to take the market availabilities of the other products into account. |
Arguments
|
|
availableRoofThicknesses -
[ProductVariant]
|
The product's roof thickness variants. List of product variants of different roof thickness that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthVerticals -
[ProductVariant]
|
The product's vertical gutter width variants. List of product variants of different vertical gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthHorizontals -
[ProductVariant]
|
The product's horizontal gutter width variants. List of product variants of different horizontal gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSiderailcolors -
[ProductVariant]
|
The product's siderailcolor variants. List of product variants of different siderailcolor that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSizes -
[ProductVariant]
|
The product's size variants. List of product variants of different size that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of size variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableTypes -
[ProductVariant]
|
List of products of different product type regardless of their categories (because different window types are usually also categorized differently in the PIM hierarchy) that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Or in short: It's more or less the product's type variants, so to speak. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the other products into account. |
Arguments
|
|
bomProducts -
[Product]
|
List of BOM co-products for if the product's isBom flag is TRUE. |
categories -
[Category]
|
The product's categories in hierarchical order. |
category -
Category
|
The product's category. |
combinable -
[CombinableProducts]
|
List of combinable products, optionally filtered by passed type of combination (to filter combinations by "roof terraces only", for example) and/or by passed product type(s). |
Arguments
|
|
combinationSolutions -
[SolutionProduct]
|
The available solution products for a specific product combination.
Due to requirements of VLX-1202 we need to remove this field from products. Use the provided combinationSolution query instead.
|
Arguments
|
|
compatible -
[CompatibleProduct]
|
List of compatible products, optionally filtered by passed type of compatibility (to filter compatibilities by "flashings only", for example) and/or by passed product type(s). |
Arguments
|
|
deliveryTime -
Int
|
The product's delivery time in workdays. |
Arguments
|
|
description -
String!
|
will be removed, use shortCommercialDescription instead
will be removed, use shortCommercialDescription instead
|
descriptionLong -
String!
|
will be removed, use longCommercialDescription instead
will be removed, use longCommercialDescription instead
|
dessin -
Dessin
|
The product's dessin. |
domeColor -
DomeColor
|
The product's dome color (if set, otherwise null). |
domeKerbHeight -
DomeKerbHeight
|
The product's dome kerb height (if set, otherwise null). |
domeLayer -
DomeLayer
|
The product's dome layer name (if set, otherwise null). |
ean -
String!
|
The product's EAN (European Article Number) as set in the PIM. |
effectiveDaylightArea -
Area
|
The product's effective daylight area. |
exterior -
Exterior
|
The product's exterior finish. |
flange -
Flange
|
The product's flange (if set, otherwise null). |
frwCombinations -
[FrwCombination]
|
The product's FRW combinations with other products. |
generation -
ProductGeneration
|
The product generation (e.g. V22). |
glazing -
Glazing
|
The product's glazing. |
gutterWidthVertical -
GutterWidthVertical
|
The product's vertical gutter width (if set, otherwise null). |
gutterWidthHorizontal -
GutterWidthHorizontal
|
The product's horizontal gutter width (if set, otherwise null). |
height -
Height
|
The product's height code (if set, otherwise null). |
hinging -
Hinging
|
The product's hinging (if set, otherwise null). |
id -
ID!
|
The product's ID as used internally in the application-service. |
imagePrimary -
Image
|
The product's primary image. |
imagesSecondary -
[Image]
|
The product's secondary images. |
Arguments
|
|
interior -
Interior
|
The product's interior finish. |
isBom -
Boolean!
|
Determines if this is a BOM product. See also bomProducts. Be aware that the isBom flag is market specific, thus it relies on the country parameter being passed to the query. |
isBurglaryResistant -
Boolean!
|
Determines if this product is burglary resistant. |
isEligible -
Boolean
|
Determines if the product is eligible in the current country (as passed to the query or as passed to this field as argument). You might also be interested in the thermalTransmittance field. |
Arguments
|
|
isProDelivery -
Boolean!
|
Determines if this product supports pro-delivery. |
isProfessionalsProductProgram -
Boolean!
|
Determines if this product is part of the professionals product program for the current country being passed to the query. |
length -
Length
|
The product's length code (if set, otherwise null). |
longCommercialDescription -
String
|
The product's long commercial name as set in the PIM export as Product_LongCommercialDescription. |
longCommercialName -
String!
|
The product's long commercial name as set in the PIM export as Product_LongCommercialName. If the product's long name cannot be found then the VCI will be returned. |
marketIntroduction -
String
|
The product's market introduction date as string.
If the format argument is omitted then the result will be formatted with the default ISO_8601 ("YYYY-MM-DD"). |
Arguments
|
|
materialDescription -
String
|
The product's material description as set in the PIM export as sapMaterialDescription. |
name -
String!
|
will be removed, use shortCommercialName instead
will be removed, use shortCommercialName instead
|
nameLong -
String!
|
will be removed, use longCommercialName instead
will be removed, use longCommercialName instead
|
operation -
Operation
|
The product's operation. |
price -
Price
|
The product's price for given country code. |
Arguments
|
|
prices -
[Price]
|
The product's prices for different countries / markets. |
roofThickness -
RoofThickness
|
The product's roof thickness (if set, otherwise null). |
searchData -
String!
|
JSON formatted string of the search data as sent to the search-service for indexing the product. |
Arguments
|
|
searchTerms -
[String]
|
List of search terms as sent to the search-service for indexing the product. |
Arguments
|
|
shortCommercialDescription -
String
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialDescription |
shortCommercialName -
String!
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialName. If the product's short name cannot be found then the VCE will be returned. |
siderailcolor -
Siderailcolor
|
The product's siderail color. |
size -
Size
|
The product's size. |
soundInsulation -
String
|
The product's sound insulation. |
status -
Int
|
The product's availability status for the current market as being set in the SAP distribution chain specific status field of the PIM. Be aware that this field requires you to pass in a country code to the query to actually determine such a market that the product status has to be returned for. |
thermalTransmittance -
String
|
The product's thermal transmittance. You might also be interested in having a look at the isEligible field. |
totalSolarEnergyTransmittance -
Float
|
The product's total solar energy transmittance. |
translations -
[Translation]
|
Translation entries being related to the product. |
Arguments
|
|
type -
Type
|
The product's type. |
vce -
String!
|
The product's VCE as set in the PIM. |
vci -
String!
|
The product's VCI as set in the PIM. |
combinationType -
String
|
The relation type of how the products are combinable with each other. |
compatibilityId -
Int
|
The application-service-internal database ID of the underlying compatibility which the combinable products are referenced to. |
count -
Int
|
The number of times this product is being added to the product combination. |
solutions -
[SolutionProduct]
|
The available solutions for a specific product combination.
A solution is basically just a product, but one with a list of additionally required other products (which might be empty, though). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the solution products into account. |
Arguments
|
|
solutionsId -
String
|
The available solutions (database IDs) for current product combination as JSON formatted string.
The JSON object (when decoded) contains only those products' IDs that do exist in the application-service's internal database. Or in other words: All returned IDs belong to products that have actually been imported. Be aware, though, that the product IDs are not filtered by availability for the current country (if passed to the query). It's up to you (the API user) to take care of that yourself.
See also the solutionsVci field which returns the same structure using VCIs instead of IDs, but where the results are not filtered by products that do exist in our databases. |
solutionsVci -
String
|
The available solutions (product VCIs) for current product combination as JSON formatted string.
Be aware that the JSON object (when decoded) contains VCIs of all products, including those that we might not have imported at all into our databases. Also keep in mind that the product VCIs are not filtered by availability for the current country (if passed to the query). That being said, it's up to you (the API user) to not blindly rely on the lists of VCIs being returned.
See also the solutionsId field which returns the same structure with application-service internal database IDs and which is filtered by products that do exist in our databases. |
Example
{
"addon": Addon,
"airPermeability": 987,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [ProductVariant],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 987,
"description": "xyz789",
"descriptionLong": "abc123",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "xyz789",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": 4,
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": false,
"isBurglaryResistant": true,
"isEligible": false,
"isProDelivery": false,
"isProfessionalsProductProgram": false,
"length": Length,
"longCommercialDescription": "xyz789",
"longCommercialName": "xyz789",
"marketIntroduction": "abc123",
"materialDescription": "xyz789",
"name": "abc123",
"nameLong": "xyz789",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "xyz789",
"searchTerms": ["xyz789"],
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "abc123",
"status": 123,
"thermalTransmittance": "xyz789",
"totalSolarEnergyTransmittance": 123.45,
"translations": [Translation],
"type": Type,
"vce": "xyz789",
"vci": "xyz789",
"combinationType": "xyz789",
"compatibilityId": 123,
"count": 987,
"solutions": [SolutionProduct],
"solutionsId": "abc123",
"solutionsVci": "abc123"
}
CombinableProducts
Description
A list of combinable products.
Fields
| Field Name | Description |
|---|---|
products -
[CombinableProduct]
|
The products being combinable to the current one. |
Example
{"products": [CombinableProduct]}
Combination
Description
A product combination.
Fields
| Field Name | Description |
|---|---|
id -
ID
|
The combination's application-service-internal database ID. |
products -
[CombinableProduct]
|
List of this combination's products. |
solutions -
[SolutionProduct]
|
The available solutions for the current product combination.
A solution is basically just a product, but one with a list of additionally required other products (which might be empty, though). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the solution products into account. |
Arguments
|
|
solutionsId -
String
|
The available solutions (database IDs) for current product combination as JSON formatted string.
The JSON object (when decoded) contains only those products' IDs that do exist in the application-service's internal database. Or in other words: All returned IDs belong to products that have actually been imported. Be aware, though, that the product IDs are not filtered by availability for the current country (if passed to the query). It's up to you (the API user) to take care of that yourself.
See also the solutionsVci field which returns the same structure using VCIs instead of IDs, but where the results are not filtered by products that do exist in our databases. |
solutionsVci -
String
|
The available solutions (product VCIs) for current product combination as JSON formatted string.
Be aware that the JSON object (when decoded) contains VCIs of all products, including those that we might not have imported at all into our databases. Also keep in mind that the product VCIs are not filtered by availability for the current country (if passed to the query). That being said, it's up to you (the API user) to not blindly rely on the lists of VCIs being returned.
See also the solutionsId field which returns the same structure with application-service internal database IDs and which is filtered by products that do exist in our databases. |
type -
String
|
The combination type. |
Example
{
"id": "4",
"products": [CombinableProduct],
"solutions": [SolutionProduct],
"solutionsId": "xyz789",
"solutionsVci": "xyz789",
"type": "xyz789"
}
CombinationType
Description
The types which a product combination can be of. It more or less describes what kind of product is combinable to another. Have in mind, though, that this type is by no means a "product type". → This type is simply a classification of how two (combinable) products are related to each other.
Values
| Enum Value | Description |
|---|---|
|
|
Filters combinable products by relations of type "roof balcony or sloped extension". |
|
|
Filters combinable products by relations of type "dormer". |
|
|
Filters combinable products by relations of type "vertical extension". |
|
|
Filters combinable products by relations of type "roof terrace". |
|
|
Filters combinable products by relations of type "roof terrace flashings". |
|
|
Filters combinable products by relations of type "mini-dormer combi flashings". |
Example
"ROOF_BALCONY_OR_SLOPED_EXTENSION"
Compatibility
Description
A product compatibility.
Fields
| Field Name | Description |
|---|---|
id -
ID
|
The compatibility's application-service-internal database ID. |
products -
[CompatibleProduct]
|
List of this compatibility's products. |
type -
String
|
The compatibility type. |
additionallyRequired -
[Product]
|
The additionally required products for the current product compatibility. |
Arguments
|
|
additionallyRequiredId -
String
|
The additionally required products (database IDs) for current product combination as JSON formatted string.
The JSON object (when decoded) contains only those products' IDs that do exist in the application-service's internal database. Or in other words: All returned IDs belong to products that have actually been imported. Be aware, though, that the product IDs are not filtered by availability for the current country (if passed to the query). It's up to you (the API user) to take care of that yourself.
See also the additionallyRequiredVci field which returns the same structure using VCIs instead of IDs, but where the results are not filtered by products that do exist in our databases. |
additionallyRequiredVci -
String
|
The additionally required products (VCIs) for current product compatibility as JSON formatted string.
Be aware that the JSON object (when decoded) contains VCIs of all products, including those that we might not have imported at all into our databases. Also keep in mind that the product VCIs are not filtered by availability for the current country (if passed to the query). That being said, it's up to you (the API user) to not blindly rely on the lists of VCIs being returned.
See also the additionallyRequiredId field which returns the same structure with application-service internal database IDs and which is filtered by products that do exist in our databases. |
Example
{
"id": 4,
"products": [CompatibleProduct],
"type": "abc123",
"additionallyRequired": [Product],
"additionallyRequiredId": "abc123",
"additionallyRequiredVci": "abc123"
}
CompatibilityType
Description
The types which a product compatibility can be of. It more or less describes what kind of product is compatible to another. Have in mind, though, that this type is by no means a "product type" (in the end it probably somehow is, but technically it's something different). → This type is simply a classification of how two (compatible) products are related to each other.
Values
| Enum Value | Description |
|---|---|
|
|
Filters compatible products by relations of type "blinds and shutters" which are the so-called DSP products. |
|
|
Filters compatible products by relations of type "flashings single". |
|
|
Filters compatible products by relations of type "flashings 1x2". |
|
|
Filters compatible products by relations of type "flashings 2x1". |
|
|
Filters compatible products by relations of type "flashings 2x2". |
|
|
Filters compatible products by relations of type "flashings 3x1". |
|
|
Filters compatible products by relations of type "flashings 3x2". |
|
|
Filters compatible products by relations of type "dormer flashings". |
|
|
Filters compatible products by relations of type "mini-dormer flashings". |
|
|
Filters compatible products by relations of type "roof ridge flashings". |
|
|
Filters compatible products by relations of type "linings single". |
|
|
Filters compatible products by relations of type "linings 2x1". |
|
|
Filters compatible products by relations of type "linings 3x1". |
|
|
Filters compatible products by relations of type "frw linings". |
|
|
Filters compatible products by relations of type "frw vapour barriers". |
Example
"DSP"
CompatibleProduct
Description
A product being compatible with another one (such as blinds, shutters, linings and flashings).
Fields
| Field Name | Description |
|---|---|
addon -
Addon
|
The product's additional products (if set, otherwise null). |
airPermeability -
Int
|
The product's air permeability. |
availableAddons -
[ProductVariant]
|
The product's addon variants. List of product variants of different addon that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDessins -
[ProductVariant]
|
The product's dessin variants. List of product variants of different dessin that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeColors -
[ProductVariant]
|
The product's dome color variants ("clear" / "opaque" / etc.). List of product variants of different dome colors that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeKerbHeights -
[ProductVariant]
|
The product's dome heights variants. List of product variants of different dome heights that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeLayers -
[ProductVariant]
|
The product's dome layers variants. List of product variants of different dome layers that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableExteriors -
[ProductVariant]
|
The product's exterior variants. List of product variants of different exterior finish that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableFlanges -
[ProductVariant]
|
The product's flanges variants. List of product variants of different flanges that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGlazings -
[ProductVariant]
|
The product's glazing variants. List of product variants of different glazing that share the exact same other characteristics with the current product (same size, same interior finish, same exterior finish etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHeights -
[ProductVariant]
|
The product's height variants. List of product variants of different height that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of height variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHingings -
[ProductVariant]
|
The product's hinging variants. List of product variants of different hinging that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableInteriors -
[ProductVariant]
|
The product's interior variants. List of product variants of different interior finish that share the exact same other characteristics with the current product (same size, same exterior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableLengths -
[ProductVariant]
|
The product's length variants. List of product variants of different length that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of length variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableOperations -
[ProductVariant]
|
The product's operation variants. List of product variants of different operation that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableProductVariants -
[ProductVariant]
|
List of products sharing the exact same characteristics with the current product (e.g. same size, same interior finish, same glazing etc.), see argument same. Or in short: It's listing the product's variants dependant on given characteristics.
Be aware that this field requires you to pass in a country code or a locale to the query to take the market availabilities of the other products into account. |
Arguments
|
|
availableRoofThicknesses -
[ProductVariant]
|
The product's roof thickness variants. List of product variants of different roof thickness that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthVerticals -
[ProductVariant]
|
The product's vertical gutter width variants. List of product variants of different vertical gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthHorizontals -
[ProductVariant]
|
The product's horizontal gutter width variants. List of product variants of different horizontal gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSiderailcolors -
[ProductVariant]
|
The product's siderailcolor variants. List of product variants of different siderailcolor that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSizes -
[ProductVariant]
|
The product's size variants. List of product variants of different size that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of size variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableTypes -
[ProductVariant]
|
List of products of different product type regardless of their categories (because different window types are usually also categorized differently in the PIM hierarchy) that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Or in short: It's more or less the product's type variants, so to speak. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the other products into account. |
Arguments
|
|
bomProducts -
[Product]
|
List of BOM co-products for if the product's isBom flag is TRUE. |
categories -
[Category]
|
The product's categories in hierarchical order. |
category -
Category
|
The product's category. |
combinable -
[CombinableProducts]
|
List of combinable products, optionally filtered by passed type of combination (to filter combinations by "roof terraces only", for example) and/or by passed product type(s). |
Arguments
|
|
combinationSolutions -
[SolutionProduct]
|
The available solution products for a specific product combination.
Due to requirements of VLX-1202 we need to remove this field from products. Use the provided combinationSolution query instead.
|
Arguments
|
|
compatible -
[CompatibleProduct]
|
List of compatible products, optionally filtered by passed type of compatibility (to filter compatibilities by "flashings only", for example) and/or by passed product type(s). |
Arguments
|
|
deliveryTime -
Int
|
The product's delivery time in workdays. |
Arguments
|
|
description -
String!
|
will be removed, use shortCommercialDescription instead
will be removed, use shortCommercialDescription instead
|
descriptionLong -
String!
|
will be removed, use longCommercialDescription instead
will be removed, use longCommercialDescription instead
|
dessin -
Dessin
|
The product's dessin. |
domeColor -
DomeColor
|
The product's dome color (if set, otherwise null). |
domeKerbHeight -
DomeKerbHeight
|
The product's dome kerb height (if set, otherwise null). |
domeLayer -
DomeLayer
|
The product's dome layer name (if set, otherwise null). |
ean -
String!
|
The product's EAN (European Article Number) as set in the PIM. |
effectiveDaylightArea -
Area
|
The product's effective daylight area. |
exterior -
Exterior
|
The product's exterior finish. |
flange -
Flange
|
The product's flange (if set, otherwise null). |
frwCombinations -
[FrwCombination]
|
The product's FRW combinations with other products. |
generation -
ProductGeneration
|
The product generation (e.g. V22). |
glazing -
Glazing
|
The product's glazing. |
gutterWidthVertical -
GutterWidthVertical
|
The product's vertical gutter width (if set, otherwise null). |
gutterWidthHorizontal -
GutterWidthHorizontal
|
The product's horizontal gutter width (if set, otherwise null). |
height -
Height
|
The product's height code (if set, otherwise null). |
hinging -
Hinging
|
The product's hinging (if set, otherwise null). |
id -
ID!
|
The product's ID as used internally in the application-service. |
imagePrimary -
Image
|
The product's primary image. |
imagesSecondary -
[Image]
|
The product's secondary images. |
Arguments
|
|
interior -
Interior
|
The product's interior finish. |
isBom -
Boolean!
|
Determines if this is a BOM product. See also bomProducts. Be aware that the isBom flag is market specific, thus it relies on the country parameter being passed to the query. |
isBurglaryResistant -
Boolean!
|
Determines if this product is burglary resistant. |
isEligible -
Boolean
|
Determines if the product is eligible in the current country (as passed to the query or as passed to this field as argument). You might also be interested in the thermalTransmittance field. |
Arguments
|
|
isProDelivery -
Boolean!
|
Determines if this product supports pro-delivery. |
isProfessionalsProductProgram -
Boolean!
|
Determines if this product is part of the professionals product program for the current country being passed to the query. |
length -
Length
|
The product's length code (if set, otherwise null). |
longCommercialDescription -
String
|
The product's long commercial name as set in the PIM export as Product_LongCommercialDescription. |
longCommercialName -
String!
|
The product's long commercial name as set in the PIM export as Product_LongCommercialName. If the product's long name cannot be found then the VCI will be returned. |
marketIntroduction -
String
|
The product's market introduction date as string.
If the format argument is omitted then the result will be formatted with the default ISO_8601 ("YYYY-MM-DD"). |
Arguments
|
|
materialDescription -
String
|
The product's material description as set in the PIM export as sapMaterialDescription. |
name -
String!
|
will be removed, use shortCommercialName instead
will be removed, use shortCommercialName instead
|
nameLong -
String!
|
will be removed, use longCommercialName instead
will be removed, use longCommercialName instead
|
operation -
Operation
|
The product's operation. |
price -
Price
|
The product's price for given country code. |
Arguments
|
|
prices -
[Price]
|
The product's prices for different countries / markets. |
roofThickness -
RoofThickness
|
The product's roof thickness (if set, otherwise null). |
searchData -
String!
|
JSON formatted string of the search data as sent to the search-service for indexing the product. |
Arguments
|
|
searchTerms -
[String]
|
List of search terms as sent to the search-service for indexing the product. |
Arguments
|
|
shortCommercialDescription -
String
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialDescription |
shortCommercialName -
String!
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialName. If the product's short name cannot be found then the VCE will be returned. |
siderailcolor -
Siderailcolor
|
The product's siderail color. |
size -
Size
|
The product's size. |
soundInsulation -
String
|
The product's sound insulation. |
status -
Int
|
The product's availability status for the current market as being set in the SAP distribution chain specific status field of the PIM. Be aware that this field requires you to pass in a country code to the query to actually determine such a market that the product status has to be returned for. |
thermalTransmittance -
String
|
The product's thermal transmittance. You might also be interested in having a look at the isEligible field. |
totalSolarEnergyTransmittance -
Float
|
The product's total solar energy transmittance. |
translations -
[Translation]
|
Translation entries being related to the product. |
Arguments
|
|
type -
Type
|
The product's type. |
vce -
String!
|
The product's VCE as set in the PIM. |
vci -
String!
|
The product's VCI as set in the PIM. |
compatibilityId -
Int
|
The application-service-internal database ID of the underlying compatibility which the compatible products are referenced to. |
compatibilityRules -
[String]
|
The list of compatibility rules to be applied to the relation of compatible products. In case of no description for a rule can be found the rule's PIM-ID will be returned. |
compatibilityType -
String
|
The relation type of how the products are compatible to each other. |
count -
Int
|
The number of times this product is being added to the product compatibility. |
Example
{
"addon": Addon,
"airPermeability": 987,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [ProductVariant],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 123,
"description": "xyz789",
"descriptionLong": "abc123",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "abc123",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": "4",
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": false,
"isBurglaryResistant": false,
"isEligible": false,
"isProDelivery": false,
"isProfessionalsProductProgram": true,
"length": Length,
"longCommercialDescription": "abc123",
"longCommercialName": "abc123",
"marketIntroduction": "xyz789",
"materialDescription": "abc123",
"name": "xyz789",
"nameLong": "xyz789",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "abc123",
"searchTerms": ["xyz789"],
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "abc123",
"status": 987,
"thermalTransmittance": "abc123",
"totalSolarEnergyTransmittance": 123.45,
"translations": [Translation],
"type": Type,
"vce": "xyz789",
"vci": "abc123",
"compatibilityId": 123,
"compatibilityRules": ["xyz789"],
"compatibilityType": "abc123",
"count": 123
}
DateFormat
Description
The formats being available for retrieving dates.
Values
| Enum Value | Description |
|---|---|
|
|
The date will be formatted as YYYY-MM-DD according to the international standard
ISO 8601. |
|
|
The date will be formatted as YYYY-MM-DD (same as ISO_8601). |
|
|
The date will be formatted as MM/DD/YYYY. |
|
|
The date will be formatted as DD.MM.YYYY. |
Example
"ISO_8601"
Dessin
Description
A product's dessin.
Fields
| Field Name | Description |
|---|---|
code -
String
|
A product's dessin code as being part of the VCI/VCE, e.g. 1085 (for beige). |
color -
String
|
The dessin's color as set in the PIM as Colour Name. |
materialAndColor -
String
|
The dessin's material and color as set in the PIM as Material and Colour. |
description -
String
|
will be removed, use shortCommercialDescription instead
will be removed, use shortCommercialDescription instead
|
id -
ID!
|
The dessin's database ID. |
image -
Image
|
|
longCommercialDescription -
String
|
The dessin's long commercial name as set in the PIM export as Dessin_LongCommercialDescription. |
longCommercialName -
String
|
The dessin's long commercial name as set in the PIM export as Dessin_LongCommercialName. |
name -
String
|
will be removed, use shortCommercialName instead
will be removed, use shortCommercialName instead
|
shortCommercialDescription -
String
|
The dessin's short commercial name as set in the PIM export as Dessin_ShortCommercialDescription |
shortCommercialName -
String
|
The dessin's short commercial name as set in the PIM export as Dessin_ShortCommercialName. |
translations -
[Translation]
|
Translation entries being related to the dessin. |
Arguments
|
|
Example
{
"code": "abc123",
"color": "xyz789",
"materialAndColor": "xyz789",
"description": "xyz789",
"id": "4",
"image": Image,
"longCommercialDescription": "xyz789",
"longCommercialName": "xyz789",
"name": "xyz789",
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"translations": [Translation]
}
DomeColor
Description
A product's dome color.
Example
{
"id": "4",
"pimId": "xyz789",
"name": "xyz789",
"color": "xyz789"
}
DomeKerbHeight
DomeLayer
Exterior
Description
A product's exterior finish (or as it's also called sometimes: the outer material or the outer surface).
Fields
| Field Name | Description |
|---|---|
code -
String
|
A product's exterior code as being part of the VCI/VCE, e.g. 0 (for aluminium). |
colorName -
String
|
The outer surface's color as name. |
colorRal -
Int
|
The outer surface's color as RAL code. |
description -
String
|
The outer surface's name as set in the PIM as Exterior Finish Short Commercial Description.
Use shortCommercialDescription instead.
|
id -
ID!
|
The exterior's database ID. |
image -
Image
|
|
longCommercialDescription -
String
|
The exterior's long commercial name as set in the PIM export as ExteriorFinish_LongCommercialDescription. |
longCommercialName -
String
|
The exterior's long commercial name as set in the PIM export as ExteriorFinish_LongCommercialName. |
material -
String
|
The outer surface's material name as set in the PIM as Outer Material Name. |
name -
String!
|
The outer surface's name as set in the PIM as Exterior Finish Short Commercial Name.
Use shortCommercialName instead.
|
shortCommercialDescription -
String
|
The exterior's short commercial name as set in the PIM export as ExteriorFinish_ShortCommercialDescription |
shortCommercialName -
String
|
The exterior's short commercial name as set in the PIM export as ExteriorFinish_ShortCommercialName. |
translations -
[Translation]
|
Translation entries being related to the outer surface. |
Arguments
|
|
Example
{
"code": "xyz789",
"colorName": "xyz789",
"colorRal": 123,
"description": "xyz789",
"id": "4",
"image": Image,
"longCommercialDescription": "abc123",
"longCommercialName": "abc123",
"material": "xyz789",
"name": "xyz789",
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"translations": [Translation]
}
Flange
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
987.65
FrwCombination
Description
An FRW combination containing technical data for a specific set of windows being combined.
Fields
| Field Name | Description |
|---|---|
airPermeability -
String
|
air permeability |
arcRef300 -
String
|
arc ref 300 |
bondingOfCoverGlass -
String
|
bonding of cover glass |
burglarResistanceWindow -
String
|
burglar resistance window |
externalFirePerformanceBritish -
String
|
external fire performance british |
externalFirePerformanceEuropean -
String
|
external fire performance european |
frameFactor -
String
|
frame factor |
id -
ID
|
application-service-internal database ID |
impactResistance -
String
|
impact resistance |
impactResistanceLargeSoftBody -
String
|
impact resistance large soft body |
impactResistanceSmallHardBody -
String
|
impact resistance small hard body |
lightTransmittanceIgu -
String
|
light transmittance IGU |
loadBearingCapacityOfSafety -
String
|
load bearing capacity of safety |
name -
String
|
combination name, basically a listing of all combined VCIs (e.g. CSP 100100 1073Q : ISD 100100 0110G) |
objectName -
String
|
object name |
pimId -
String
|
PIM-internal ID |
products -
[Product]
|
the combined windows |
rainNoise -
String
|
rain noise |
reactionToFire -
String
|
reaction to fire |
resistanceToDownwardLoad -
String
|
resistance to downward load |
resistanceToFireIgu -
String
|
resistance to fire IGU |
resistanceToSnowLoadFrw -
String
|
resistance to snow load FRW |
resistanceToSnowLoadIgu -
String
|
resistance to snow load IGU |
resistanceToUpwardLoad -
String
|
resistance to upward load |
resistanceToWindLoad -
String
|
resistance to wind load |
soundInsulation -
String
|
sound insulation |
thermalLinearHeatLossIgu -
String
|
thermal linear heat loss IGU |
thermalLinearHeatLossIguCalc -
String
|
thermal linear heat loss IGU calc |
thermalLinearLossBuiltin -
String
|
thermal linear loss builtin |
thermalLinearLossBuiltinCalc -
String
|
thermal linear loss builtin calc |
thermalTransmittanceCenterOgHorizontal -
String
|
thermal transmittance center OG horizontal |
thermalTransmittanceCogVertical -
String
|
thermal transmittance COG vertical |
thermalTransmittanceFrameSashCalc -
String
|
thermal transmittance frame sash calc |
thermalTransmittanceHorizontal -
String
|
thermal transmittance horizontal |
thermalTransmittanceSurfaceAreaNotCe -
String
|
thermal transmittance surface area not CE |
thermalTransmittanceUrc -
String
|
thermal transmittance URC |
totalSolarEnergyTransmittanceIgu -
String
|
total solar energy transmittance IGU |
ultravioletTransmittanceIgu -
String
|
ultraviolet transmittance IGU |
waterTightness -
String
|
water tightness |
Example
{
"airPermeability": "xyz789",
"arcRef300": "abc123",
"bondingOfCoverGlass": "xyz789",
"burglarResistanceWindow": "xyz789",
"externalFirePerformanceBritish": "abc123",
"externalFirePerformanceEuropean": "abc123",
"frameFactor": "xyz789",
"id": "4",
"impactResistance": "xyz789",
"impactResistanceLargeSoftBody": "abc123",
"impactResistanceSmallHardBody": "abc123",
"lightTransmittanceIgu": "abc123",
"loadBearingCapacityOfSafety": "abc123",
"name": "abc123",
"objectName": "abc123",
"pimId": "xyz789",
"products": [Product],
"rainNoise": "xyz789",
"reactionToFire": "xyz789",
"resistanceToDownwardLoad": "abc123",
"resistanceToFireIgu": "xyz789",
"resistanceToSnowLoadFrw": "xyz789",
"resistanceToSnowLoadIgu": "abc123",
"resistanceToUpwardLoad": "xyz789",
"resistanceToWindLoad": "abc123",
"soundInsulation": "abc123",
"thermalLinearHeatLossIgu": "abc123",
"thermalLinearHeatLossIguCalc": "xyz789",
"thermalLinearLossBuiltin": "xyz789",
"thermalLinearLossBuiltinCalc": "xyz789",
"thermalTransmittanceCenterOgHorizontal": "abc123",
"thermalTransmittanceCogVertical": "xyz789",
"thermalTransmittanceFrameSashCalc": "abc123",
"thermalTransmittanceHorizontal": "abc123",
"thermalTransmittanceSurfaceAreaNotCe": "abc123",
"thermalTransmittanceUrc": "abc123",
"totalSolarEnergyTransmittanceIgu": "abc123",
"ultravioletTransmittanceIgu": "abc123",
"waterTightness": "xyz789"
}
Glazing
Description
A product's glazing.
Fields
| Field Name | Description |
|---|---|
code -
String
|
A product's glazing code as being part of the VCI/VCE, e.g. 68 (for 3-layer glazing). |
componentStructure -
String
|
The glazing's component structure as set in the PIM as Component Structure. |
description -
String!
|
The glazing's short description as set in the PIM as Commercial Description. |
glazingUnit -
String
|
The glazing's unit as set in the PIM as Glazing Unit. |
id -
ID!
|
The glazing's database ID. |
image -
Image
|
|
lightTransmittance -
Float
|
The glazing's light transmittance as set in the PIM as Light Transmittance IGU. |
longCommercialDescription -
String
|
The glazing's long commercial name as set in the PIM export as Glazing_LongCommercialDescription. |
longCommercialName -
String
|
The glazing's long commercial name as set in the PIM export as Glazing_LongCommercialName. |
mockCode -
String
|
A product's glazing code as to be communicated to the user. Usually this is the same as the code but from case to case it can be slightly different to match another glazing's mock_code to make them both appear to be the same, although under the hood they aren't. As an example the glazings 66 and 66L are technically different but both will be displayed to the consumer as 66 which is the mocked size code, so to speak. |
name -
String
|
The glazing's name as set in the PIM as Glazing Unit.
Use shortCommercialName instead.
|
shortCommercialDescription -
String
|
The glazing's short commercial name as set in the PIM export as Glazing_ShortCommercialDescription |
shortCommercialName -
String
|
The glazing's short commercial name as set in the PIM export as Glazing_ShortCommercialName. |
thermalTransmittance -
Float
|
The glazing's thermal transmittance as set in the PIM as Thermal Transmittance Centre Of Glass IGU. |
translations -
[Translation]
|
Translation entries being related to the glazing. |
Arguments
|
|
ultravioletTransmittance -
Float
|
The glazing's ultraviolet transmittanceset in the PIM as Ultraviolet Transmittance IGU. |
Example
{
"code": "abc123",
"componentStructure": "xyz789",
"description": "abc123",
"glazingUnit": "abc123",
"id": "4",
"image": Image,
"lightTransmittance": 987.65,
"longCommercialDescription": "abc123",
"longCommercialName": "xyz789",
"mockCode": "abc123",
"name": "xyz789",
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"thermalTransmittance": 987.65,
"translations": [Translation],
"ultravioletTransmittance": 123.45
}
GutterWidthHorizontal
GutterWidthVertical
Height
Hinging
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
Image
Description
An image asset.
Fields
| Field Name | Description |
|---|---|
alt -
String
|
The image's alt text. |
contentHubId -
String
|
The Content Hub's asset ID (or null if the image is located elsewhere). |
contentHubUrl -
String
|
The Content Hub's asset URL (or null if the image is located elsewhere). |
Arguments
|
|
id -
String
|
The image's application-service-internal database ID. |
source -
String!
|
The image's source URL as stored in the VELUX asset library also known as DAM or Content Hub. Or in other words: This is where you get the original image in full resolution. |
sourceHeight -
Int
|
The original image's height (not particularly the dimension of the image as returned by contentHubUrl, especially when passing in the aspectRatio and maxWidth arguments, but rather likely the dimension as returned by the source field). |
sourceWidth -
Int
|
The original image's width (not particularly the dimension of the image as returned by contentHubUrl, especially when passing in the aspectRatio and maxWidth arguments, but rather likely the dimension as returned by the source field). |
translations -
[Translation]
|
Translation entries being related to the image. |
Arguments
|
|
Example
{
"alt": "abc123",
"contentHubId": "xyz789",
"contentHubUrl": "abc123",
"id": "xyz789",
"source": "xyz789",
"sourceHeight": 123,
"sourceWidth": 123,
"translations": [Translation]
}
ImageAspectRatio
Description
For retrieving images you can choose from a variety of aspect ratios. These can be used to control an image's cropping. Can be combined with ImageWidth.
Values
| Enum Value | Description |
|---|---|
|
|
The image will be delivered in its original aspect ratio. It won't be cropped at all. |
|
|
The image will be delivered with an aspect ratio of 1:1 (square). Be aware that the image will likely be cropped unless the original aspect ratio is also 1:1 |
|
|
The image will be delivered with an aspect ratio of 16:9 (landscape). Be aware that the image will likely be cropped unless the original aspect ratio is also 16:9 |
|
|
The image will be delivered with an aspect ratio of 9:16 (portrait). Be aware that the image will likely be cropped unless the original aspect ratio is also 9:16 |
|
|
The image will be delivered with an aspect ratio of 4:3 (landscape). Be aware that the image will likely be cropped unless the original aspect ratio is also 4:3 |
|
|
The image will be delivered with an aspect ratio of 3:4 (portrait). Be aware that the image will likely be cropped unless the original aspect ratio is also 3:4 |
Example
"Original"
ImageWidth
Description
For retrieving images you can choose from a variety of maximum widths. These can be used to control an image's resolution. Can be combined with ImageAspectRatio.
Values
| Enum Value | Description |
|---|---|
|
|
The delivered image will be scaled down to a bounding box being 3000 pixels wide. The bounding box' height will be automatically determined depending on its aspect ratio, e.g. with an aspect ratio of 1:1 the image will also be 3000 pixels in height. |
|
|
The delivered image will be scaled down to a bounding box being 1200 pixels wide. The bounding box' height will be automatically determined depending on its aspect ratio, e.g. with an aspect ratio of 1:1 the image will also be 1200 pixels in height. |
|
|
The delivered image will be scaled down to a bounding box being 800 pixels wide. The bounding box' height will be automatically determined depending on its aspect ratio, e.g. with an aspect ratio of 1:1 the image will also be 800 pixels in height. |
|
|
The delivered image will be scaled down to a bounding box being 480 pixels wide. The bounding box' height will be automatically determined depending on its aspect ratio, e.g. with an aspect ratio of 1:1 the image will also be 480 pixels in height. |
|
|
The delivered image will be scaled down to a bounding box being 320 pixels wide. The bounding box' height will be automatically determined depending on its aspect ratio, e.g. with an aspect ratio of 1:1 the image will also be 320 pixels in height. |
Example
"_3000"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Interior
Description
A product's interior finish (or as it's also called sometimes: the inner surface).
Fields
| Field Name | Description |
|---|---|
code -
String
|
A product's interior code as being part of the VCI/VCE, e.g. 0 (for white polyurethane). |
colorName -
String
|
The inner surface's color as name. |
colorRal -
Int
|
The inner surface's color as RAL code. |
description -
String
|
The inner surface's description as set in the PIM as Short Commercial Description.
Use shortCommercialDescription instead.
|
id -
ID!
|
The interior's database ID. |
image -
Image
|
|
longCommercialDescription -
String
|
The interior's long commercial name as set in the PIM export as InteriorFinish_LongCommercialDescription. |
longCommercialName -
String
|
The interior's long commercial name as set in the PIM export as InteriorFinish_LongCommercialName. |
name -
String
|
The inner surface's name as set in the PIM as Short Commercial Name.
Use shortCommercialName instead.
|
shortCommercialDescription -
String
|
The interior's short commercial name as set in the PIM export as InteriorFinish_ShortCommercialDescription |
shortCommercialName -
String
|
The interior's short commercial name as set in the PIM export as InteriorFinish_ShortCommercialName. |
surfaceFinish -
String
|
The inner surface's finish name as set in the PIM as Maintenance Inner Surface Finish. |
surfaceName -
String
|
The inner surface's name as set in the PIM as PDC Inner Surface Name. |
translations -
[Translation]
|
Translation entries being related to the inner surface. |
Arguments
|
|
Example
{
"code": "xyz789",
"colorName": "xyz789",
"colorRal": 123,
"description": "abc123",
"id": "4",
"image": Image,
"longCommercialDescription": "xyz789",
"longCommercialName": "abc123",
"name": "xyz789",
"shortCommercialDescription": "xyz789",
"shortCommercialName": "abc123",
"surfaceFinish": "abc123",
"surfaceName": "xyz789",
"translations": [Translation]
}
Length
MeasurementUnit
Description
The measurement unit describes the quantity of a length value.
Values
| Enum Value | Description |
|---|---|
|
|
The measurement is set to millimeters (mm). |
|
|
The measurement is set to centimeters (cm). |
|
|
The measurement is set to meters (m). |
Example
"MM"
Operation
Description
A product's operation.
Fields
| Field Name | Description |
|---|---|
code -
String
|
A product's operation code as being part of the VCI/VCE, e.g. 30 (for solar powered) or null (for manual or also for fixed). |
description -
String
|
The operation's description as set in the PIM.
Use shortCommercialDescription instead.
|
id -
ID!
|
The operation's database ID. |
image -
Image
|
|
longCommercialDescription -
String
|
The operation's long commercial name as set in the PIM export as Operation_LongCommercialDescription. |
longCommercialName -
String
|
The operation's long commercial name as set in the PIM export as Operation_LongCommercialName. |
name -
String
|
The operation's name as set in the PIM.
Use shortCommercialName instead.
|
shortCommercialDescription -
String
|
The operation's short commercial name as set in the PIM export as Operation_ShortCommercialDescription |
shortCommercialName -
String
|
The operation's short commercial name as set in the PIM export as Operation_ShortCommercialName. |
translations -
[Translation]
|
Translation entries being related to the operation. |
Arguments
|
|
Example
{
"code": "abc123",
"description": "abc123",
"id": "4",
"image": Image,
"longCommercialDescription": "abc123",
"longCommercialName": "abc123",
"name": "xyz789",
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"translations": [Translation]
}
Price
Description
A product's price.
Fields
| Field Name | Description |
|---|---|
amount -
Float!
|
The price's amount for current currency (e.g. 123.45). |
country -
String!
|
The country code this price is used for. |
currencyIso -
String!
|
The price's currency code as defined in the ISO 4217 (e.g. "EUR"). See also:
https://en.wikipedia.org/wiki/ISO_4217#Active_codes. |
currencyName -
String!
|
The price's currency name (e.g. "Euro"). |
currencySymbol -
String!
|
The price's currency symbol (e.g. "€"). |
Example
{
"amount": 987.65,
"country": "xyz789",
"currencyIso": "abc123",
"currencyName": "abc123",
"currencySymbol": "abc123"
}
Product
Description
A product from the PIM.
Fields
| Field Name | Description |
|---|---|
addon -
Addon
|
The product's additional products (if set, otherwise null). |
airPermeability -
Int
|
The product's air permeability. |
availableAddons -
[ProductVariant]
|
The product's addon variants. List of product variants of different addon that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDessins -
[ProductVariant]
|
The product's dessin variants. List of product variants of different dessin that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeColors -
[ProductVariant]
|
The product's dome color variants ("clear" / "opaque" / etc.). List of product variants of different dome colors that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeKerbHeights -
[ProductVariant]
|
The product's dome heights variants. List of product variants of different dome heights that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeLayers -
[ProductVariant]
|
The product's dome layers variants. List of product variants of different dome layers that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableExteriors -
[ProductVariant]
|
The product's exterior variants. List of product variants of different exterior finish that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableFlanges -
[ProductVariant]
|
The product's flanges variants. List of product variants of different flanges that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGlazings -
[ProductVariant]
|
The product's glazing variants. List of product variants of different glazing that share the exact same other characteristics with the current product (same size, same interior finish, same exterior finish etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHeights -
[ProductVariant]
|
The product's height variants. List of product variants of different height that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of height variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHingings -
[ProductVariant]
|
The product's hinging variants. List of product variants of different hinging that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableInteriors -
[ProductVariant]
|
The product's interior variants. List of product variants of different interior finish that share the exact same other characteristics with the current product (same size, same exterior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableLengths -
[ProductVariant]
|
The product's length variants. List of product variants of different length that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of length variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableOperations -
[ProductVariant]
|
The product's operation variants. List of product variants of different operation that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableProductVariants -
[ProductVariant]
|
List of products sharing the exact same characteristics with the current product (e.g. same size, same interior finish, same glazing etc.), see argument same. Or in short: It's listing the product's variants dependant on given characteristics.
Be aware that this field requires you to pass in a country code or a locale to the query to take the market availabilities of the other products into account. |
Arguments
|
|
availableRoofThicknesses -
[ProductVariant]
|
The product's roof thickness variants. List of product variants of different roof thickness that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthVerticals -
[ProductVariant]
|
The product's vertical gutter width variants. List of product variants of different vertical gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthHorizontals -
[ProductVariant]
|
The product's horizontal gutter width variants. List of product variants of different horizontal gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSiderailcolors -
[ProductVariant]
|
The product's siderailcolor variants. List of product variants of different siderailcolor that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSizes -
[ProductVariant]
|
The product's size variants. List of product variants of different size that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of size variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableTypes -
[ProductVariant]
|
List of products of different product type regardless of their categories (because different window types are usually also categorized differently in the PIM hierarchy) that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Or in short: It's more or less the product's type variants, so to speak. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the other products into account. |
Arguments
|
|
bomProducts -
[Product]
|
List of BOM co-products for if the product's isBom flag is TRUE. |
categories -
[Category]
|
The product's categories in hierarchical order. |
category -
Category
|
The product's category. |
combinable -
[CombinableProducts]
|
List of combinable products, optionally filtered by passed type of combination (to filter combinations by "roof terraces only", for example) and/or by passed product type(s). |
Arguments
|
|
combinationSolutions -
[SolutionProduct]
|
The available solution products for a specific product combination.
Due to requirements of VLX-1202 we need to remove this field from products. Use the provided combinationSolution query instead.
|
Arguments
|
|
compatible -
[CompatibleProduct]
|
List of compatible products, optionally filtered by passed type of compatibility (to filter compatibilities by "flashings only", for example) and/or by passed product type(s). |
Arguments
|
|
deliveryTime -
Int
|
The product's delivery time in workdays. |
Arguments
|
|
description -
String!
|
will be removed, use shortCommercialDescription instead
will be removed, use shortCommercialDescription instead
|
descriptionLong -
String!
|
will be removed, use longCommercialDescription instead
will be removed, use longCommercialDescription instead
|
dessin -
Dessin
|
The product's dessin. |
domeColor -
DomeColor
|
The product's dome color (if set, otherwise null). |
domeKerbHeight -
DomeKerbHeight
|
The product's dome kerb height (if set, otherwise null). |
domeLayer -
DomeLayer
|
The product's dome layer name (if set, otherwise null). |
ean -
String!
|
The product's EAN (European Article Number) as set in the PIM. |
effectiveDaylightArea -
Area
|
The product's effective daylight area. |
exterior -
Exterior
|
The product's exterior finish. |
flange -
Flange
|
The product's flange (if set, otherwise null). |
frwCombinations -
[FrwCombination]
|
The product's FRW combinations with other products. |
generation -
ProductGeneration
|
The product generation (e.g. V22). |
glazing -
Glazing
|
The product's glazing. |
gutterWidthVertical -
GutterWidthVertical
|
The product's vertical gutter width (if set, otherwise null). |
gutterWidthHorizontal -
GutterWidthHorizontal
|
The product's horizontal gutter width (if set, otherwise null). |
height -
Height
|
The product's height code (if set, otherwise null). |
hinging -
Hinging
|
The product's hinging (if set, otherwise null). |
id -
ID!
|
The product's ID as used internally in the application-service. |
imagePrimary -
Image
|
The product's primary image. |
imagesSecondary -
[Image]
|
The product's secondary images. |
Arguments
|
|
interior -
Interior
|
The product's interior finish. |
isBom -
Boolean!
|
Determines if this is a BOM product. See also bomProducts. Be aware that the isBom flag is market specific, thus it relies on the country parameter being passed to the query. |
isBurglaryResistant -
Boolean!
|
Determines if this product is burglary resistant. |
isEligible -
Boolean
|
Determines if the product is eligible in the current country (as passed to the query or as passed to this field as argument). You might also be interested in the thermalTransmittance field. |
Arguments
|
|
isProDelivery -
Boolean!
|
Determines if this product supports pro-delivery. |
isProfessionalsProductProgram -
Boolean!
|
Determines if this product is part of the professionals product program for the current country being passed to the query. |
length -
Length
|
The product's length code (if set, otherwise null). |
longCommercialDescription -
String
|
The product's long commercial name as set in the PIM export as Product_LongCommercialDescription. |
longCommercialName -
String!
|
The product's long commercial name as set in the PIM export as Product_LongCommercialName. If the product's long name cannot be found then the VCI will be returned. |
marketIntroduction -
String
|
The product's market introduction date as string.
If the format argument is omitted then the result will be formatted with the default ISO_8601 ("YYYY-MM-DD"). |
Arguments
|
|
materialDescription -
String
|
The product's material description as set in the PIM export as sapMaterialDescription. |
name -
String!
|
will be removed, use shortCommercialName instead
will be removed, use shortCommercialName instead
|
nameLong -
String!
|
will be removed, use longCommercialName instead
will be removed, use longCommercialName instead
|
operation -
Operation
|
The product's operation. |
price -
Price
|
The product's price for given country code. |
Arguments
|
|
prices -
[Price]
|
The product's prices for different countries / markets. |
roofThickness -
RoofThickness
|
The product's roof thickness (if set, otherwise null). |
searchData -
String!
|
JSON formatted string of the search data as sent to the search-service for indexing the product. |
Arguments
|
|
searchTerms -
[String]
|
List of search terms as sent to the search-service for indexing the product. |
Arguments
|
|
shortCommercialDescription -
String
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialDescription |
shortCommercialName -
String!
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialName. If the product's short name cannot be found then the VCE will be returned. |
siderailcolor -
Siderailcolor
|
The product's siderail color. |
size -
Size
|
The product's size. |
soundInsulation -
String
|
The product's sound insulation. |
status -
Int
|
The product's availability status for the current market as being set in the SAP distribution chain specific status field of the PIM. Be aware that this field requires you to pass in a country code to the query to actually determine such a market that the product status has to be returned for. |
thermalTransmittance -
String
|
The product's thermal transmittance. You might also be interested in having a look at the isEligible field. |
totalSolarEnergyTransmittance -
Float
|
The product's total solar energy transmittance. |
translations -
[Translation]
|
Translation entries being related to the product. |
Arguments
|
|
type -
Type
|
The product's type. |
vce -
String!
|
The product's VCE as set in the PIM. |
vci -
String!
|
The product's VCI as set in the PIM. |
Example
{
"addon": Addon,
"airPermeability": 987,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [ProductVariant],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 123,
"description": "abc123",
"descriptionLong": "abc123",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "xyz789",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": 4,
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": false,
"isBurglaryResistant": false,
"isEligible": false,
"isProDelivery": false,
"isProfessionalsProductProgram": true,
"length": Length,
"longCommercialDescription": "abc123",
"longCommercialName": "abc123",
"marketIntroduction": "abc123",
"materialDescription": "xyz789",
"name": "xyz789",
"nameLong": "abc123",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "xyz789",
"searchTerms": ["xyz789"],
"shortCommercialDescription": "xyz789",
"shortCommercialName": "xyz789",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "abc123",
"status": 123,
"thermalTransmittance": "abc123",
"totalSolarEnergyTransmittance": 987.65,
"translations": [Translation],
"type": Type,
"vce": "xyz789",
"vci": "abc123"
}
ProductCharacteristic
Description
A list of characteristics that are used to retrieve a product's variants.
Values
| Enum Value | Description |
|---|---|
|
|
A product's type characteristic (e.g. GGL, GPU, CFU, EDS, VKU, ZZZ). |
|
|
A product's size characteristic (e.g. FK06, PK19, MK00, Y97). |
|
|
A product's interior characteristic (e.g. 2, 3, 7). |
|
|
A product's exterior characteristic (e.g. 1, 3, G). |
|
|
A product's glazing characteristic (e.g. 65G, 66, 66SG, 70). |
|
|
A product's operation characteristic (e.g. 21, 30). |
|
|
A product's dessin characteristic (e.g. 1100, 5060, CBYS). |
|
|
A product's siderailcolor characteristic. |
|
|
A product's length characteristic (e.g. M, FK, PK, FFKF). |
|
|
A product's height characteristic (e.g. 06, 10, 060, K2). |
|
|
A product's hinging characteristic (e.g. Left-hinged (seen from the outside), The sash is top-hung but can also be pivoted at its centre for cleaning purposes.). |
|
|
A product's addon characteristic. |
|
|
A product's roof_thickness characteristic (e.g. 300 mm, 400 mm, 500 mm). |
|
|
A product's gutter_width_vertical characteristic (e.g. 18 mm, 100 mm). |
|
|
A product's gutter_width_horizontal characteristic (e.g. 0 mm, 250 mm). |
|
|
A product's flange characteristic (e.g. With flange, Without flange). |
|
|
A product's dome_color characteristic (e.g. Dome acrylic, opaque, Flat glass, Curved glass, FRW 2.0). |
|
|
A product's dome_layer characteristic (e.g. 2-layer dome, 3-layer dome). |
|
|
A product's dome_kerb_height characteristic (e.g. 15 cm, 30 cm, 50 cm). |
Example
"Type"
ProductGeneration
ProductVariant
Description
A product variant for some product being available in a specific country.
Fields
| Field Name | Description |
|---|---|
addon -
Addon
|
The product's additional products (if set, otherwise null). |
airPermeability -
Int
|
The product's air permeability. |
availableAddons -
[ProductVariant]
|
The product's addon variants. List of product variants of different addon that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDessins -
[ProductVariant]
|
The product's dessin variants. List of product variants of different dessin that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeColors -
[ProductVariant]
|
The product's dome color variants ("clear" / "opaque" / etc.). List of product variants of different dome colors that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeKerbHeights -
[ProductVariant]
|
The product's dome heights variants. List of product variants of different dome heights that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeLayers -
[ProductVariant]
|
The product's dome layers variants. List of product variants of different dome layers that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableExteriors -
[ProductVariant]
|
The product's exterior variants. List of product variants of different exterior finish that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableFlanges -
[ProductVariant]
|
The product's flanges variants. List of product variants of different flanges that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGlazings -
[ProductVariant]
|
The product's glazing variants. List of product variants of different glazing that share the exact same other characteristics with the current product (same size, same interior finish, same exterior finish etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHeights -
[ProductVariant]
|
The product's height variants. List of product variants of different height that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of height variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHingings -
[ProductVariant]
|
The product's hinging variants. List of product variants of different hinging that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableInteriors -
[ProductVariant]
|
The product's interior variants. List of product variants of different interior finish that share the exact same other characteristics with the current product (same size, same exterior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableLengths -
[ProductVariant]
|
The product's length variants. List of product variants of different length that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of length variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableOperations -
[ProductVariant]
|
The product's operation variants. List of product variants of different operation that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableProductVariants -
[ProductVariant]
|
List of products sharing the exact same characteristics with the current product (e.g. same size, same interior finish, same glazing etc.), see argument same. Or in short: It's listing the product's variants dependant on given characteristics.
Be aware that this field requires you to pass in a country code or a locale to the query to take the market availabilities of the other products into account. |
Arguments
|
|
availableRoofThicknesses -
[ProductVariant]
|
The product's roof thickness variants. List of product variants of different roof thickness that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthVerticals -
[ProductVariant]
|
The product's vertical gutter width variants. List of product variants of different vertical gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthHorizontals -
[ProductVariant]
|
The product's horizontal gutter width variants. List of product variants of different horizontal gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSiderailcolors -
[ProductVariant]
|
The product's siderailcolor variants. List of product variants of different siderailcolor that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSizes -
[ProductVariant]
|
The product's size variants. List of product variants of different size that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of size variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableTypes -
[ProductVariant]
|
List of products of different product type regardless of their categories (because different window types are usually also categorized differently in the PIM hierarchy) that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Or in short: It's more or less the product's type variants, so to speak. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the other products into account. |
Arguments
|
|
bomProducts -
[Product]
|
List of BOM co-products for if the product's isBom flag is TRUE. |
categories -
[Category]
|
The product's categories in hierarchical order. |
category -
Category
|
The product's category. |
combinable -
[CombinableProducts]
|
List of combinable products, optionally filtered by passed type of combination (to filter combinations by "roof terraces only", for example) and/or by passed product type(s). |
Arguments
|
|
combinationSolutions -
[SolutionProduct]
|
The available solution products for a specific product combination.
Due to requirements of VLX-1202 we need to remove this field from products. Use the provided combinationSolution query instead.
|
Arguments
|
|
compatible -
[CompatibleProduct]
|
List of compatible products, optionally filtered by passed type of compatibility (to filter compatibilities by "flashings only", for example) and/or by passed product type(s). |
Arguments
|
|
deliveryTime -
Int
|
The product's delivery time in workdays. |
Arguments
|
|
description -
String!
|
will be removed, use shortCommercialDescription instead
will be removed, use shortCommercialDescription instead
|
descriptionLong -
String!
|
will be removed, use longCommercialDescription instead
will be removed, use longCommercialDescription instead
|
dessin -
Dessin
|
The product's dessin. |
domeColor -
DomeColor
|
The product's dome color (if set, otherwise null). |
domeKerbHeight -
DomeKerbHeight
|
The product's dome kerb height (if set, otherwise null). |
domeLayer -
DomeLayer
|
The product's dome layer name (if set, otherwise null). |
ean -
String!
|
The product's EAN (European Article Number) as set in the PIM. |
effectiveDaylightArea -
Area
|
The product's effective daylight area. |
exterior -
Exterior
|
The product's exterior finish. |
flange -
Flange
|
The product's flange (if set, otherwise null). |
frwCombinations -
[FrwCombination]
|
The product's FRW combinations with other products. |
generation -
ProductGeneration
|
The product generation (e.g. V22). |
glazing -
Glazing
|
The product's glazing. |
gutterWidthVertical -
GutterWidthVertical
|
The product's vertical gutter width (if set, otherwise null). |
gutterWidthHorizontal -
GutterWidthHorizontal
|
The product's horizontal gutter width (if set, otherwise null). |
height -
Height
|
The product's height code (if set, otherwise null). |
hinging -
Hinging
|
The product's hinging (if set, otherwise null). |
id -
ID!
|
The product's ID as used internally in the application-service. |
imagePrimary -
Image
|
The product's primary image. |
imagesSecondary -
[Image]
|
The product's secondary images. |
Arguments
|
|
interior -
Interior
|
The product's interior finish. |
isBom -
Boolean!
|
Determines if this is a BOM product. See also bomProducts. Be aware that the isBom flag is market specific, thus it relies on the country parameter being passed to the query. |
isBurglaryResistant -
Boolean!
|
Determines if this product is burglary resistant. |
isEligible -
Boolean
|
Determines if the product is eligible in the current country (as passed to the query or as passed to this field as argument). You might also be interested in the thermalTransmittance field. |
Arguments
|
|
isProDelivery -
Boolean!
|
Determines if this product supports pro-delivery. |
isProfessionalsProductProgram -
Boolean!
|
Determines if this product is part of the professionals product program for the current country being passed to the query. |
length -
Length
|
The product's length code (if set, otherwise null). |
longCommercialDescription -
String
|
The product's long commercial name as set in the PIM export as Product_LongCommercialDescription. |
longCommercialName -
String!
|
The product's long commercial name as set in the PIM export as Product_LongCommercialName. If the product's long name cannot be found then the VCI will be returned. |
marketIntroduction -
String
|
The product's market introduction date as string.
If the format argument is omitted then the result will be formatted with the default ISO_8601 ("YYYY-MM-DD"). |
Arguments
|
|
materialDescription -
String
|
The product's material description as set in the PIM export as sapMaterialDescription. |
name -
String!
|
will be removed, use shortCommercialName instead
will be removed, use shortCommercialName instead
|
nameLong -
String!
|
will be removed, use longCommercialName instead
will be removed, use longCommercialName instead
|
operation -
Operation
|
The product's operation. |
price -
Price
|
The price this product variant is available for in the current country. |
prices -
[Price]
|
The product's prices for different countries / markets. |
roofThickness -
RoofThickness
|
The product's roof thickness (if set, otherwise null). |
searchData -
String!
|
JSON formatted string of the search data as sent to the search-service for indexing the product. |
Arguments
|
|
searchTerms -
[String]
|
List of search terms as sent to the search-service for indexing the product. |
Arguments
|
|
shortCommercialDescription -
String
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialDescription |
shortCommercialName -
String!
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialName. If the product's short name cannot be found then the VCE will be returned. |
siderailcolor -
Siderailcolor
|
The product's siderail color. |
size -
Size
|
The product's size. |
soundInsulation -
String
|
The product's sound insulation. |
status -
Int
|
The product's availability status for the current market as being set in the SAP distribution chain specific status field of the PIM. Be aware that this field requires you to pass in a country code to the query to actually determine such a market that the product status has to be returned for. |
thermalTransmittance -
String
|
The product's thermal transmittance. You might also be interested in having a look at the isEligible field. |
totalSolarEnergyTransmittance -
Float
|
The product's total solar energy transmittance. |
translations -
[Translation]
|
Translation entries being related to the product. |
Arguments
|
|
type -
Type
|
The product's type. |
vce -
String!
|
The product's VCE as set in the PIM. |
vci -
String!
|
The product's VCI as set in the PIM. |
country -
String
|
The country code this product variant is available for. |
Example
{
"addon": Addon,
"airPermeability": 123,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [ProductVariant],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 123,
"description": "abc123",
"descriptionLong": "xyz789",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "xyz789",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": "4",
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": true,
"isBurglaryResistant": true,
"isEligible": true,
"isProDelivery": false,
"isProfessionalsProductProgram": true,
"length": Length,
"longCommercialDescription": "abc123",
"longCommercialName": "xyz789",
"marketIntroduction": "abc123",
"materialDescription": "xyz789",
"name": "xyz789",
"nameLong": "xyz789",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "xyz789",
"searchTerms": ["xyz789"],
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "xyz789",
"status": 123,
"thermalTransmittance": "xyz789",
"totalSolarEnergyTransmittance": 987.65,
"translations": [Translation],
"type": Type,
"vce": "xyz789",
"vci": "abc123",
"country": "xyz789"
}
RoofThickness
Siderailcolor
Description
A product's siderail color.
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
The siderail color's database ID. |
image -
Image
|
|
longCommercialDescription -
String
|
The siderail color's long commercial name as set in the PIM export as Listcolor_LongCommercialDescription. |
longCommercialName -
String
|
The siderail color's long commercial name as set in the PIM export as Listcolor_LongCommercialName. |
name -
String
|
will be removed, use shortCommercialName instead
will be removed, use shortCommercialName instead
|
shortCommercialDescription -
String
|
The siderail color's short commercial name as set in the PIM export as Listcolor_ShortCommercialDescription |
shortCommercialName -
String
|
The siderail color's short commercial name as set in the PIM export as Listcolor_ShortCommercialName. |
translations -
[Translation]
|
Translation entries being related to the siderail color. |
Arguments
|
|
Example
{
"id": "4",
"image": Image,
"longCommercialDescription": "abc123",
"longCommercialName": "abc123",
"name": "xyz789",
"shortCommercialDescription": "xyz789",
"shortCommercialName": "abc123",
"translations": [Translation]
}
Size
Description
A product's size.
Fields
| Field Name | Description |
|---|---|
code -
String
|
A product's size code as being part of the VCI/VCE, e.g. MK06 (for 780×1178 mm). |
diffuserCutOutDimension -
Float
|
The diffuser cut-out dimension (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
externalFrameHeight -
Float
|
The external frame height (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
externalFrameWidth -
Float
|
The external frame width (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
heightCm -
Float
|
The external frame height in centimeter.
Field will be removed soon, please use externalFrameHeight instead.
|
heightM -
Float
|
The external frame height in meter.
Field will be removed soon, please use externalFrameHeight instead.
|
heightMm -
Float
|
The external frame height in millimeter.
Field will be removed soon, please use externalFrameHeight instead.
|
id -
ID!
|
The size's database ID. |
innerWallHeightMax -
Float
|
The maximum inner wall height (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
innerWallHeightMin -
Float
|
The minimum inner wall height (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
innerWallWidthMax -
Float
|
The maximum inner wall width (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
innerWallWidthMin -
Float
|
The minimum inner wall width (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
roofOpeningHeight -
Float
|
The roof opening height (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
roofOpeningWidth -
Float
|
The roof opening width (by default in millimeters, can be changed, though, by passing a unit argument). |
Arguments
|
|
widthCm -
Float
|
The external frame width in centimeter.
Field will be removed soon, please use externalFrameWidth instead.
|
widthM -
Float
|
The external frame width in meter.
Field will be removed soon, please use externalFrameWidth instead.
|
widthMm -
Float
|
The external frame width in millimeter.
Field will be removed soon, please use externalFrameWidth instead.
|
Example
{
"code": "xyz789",
"diffuserCutOutDimension": 987.65,
"externalFrameHeight": 987.65,
"externalFrameWidth": 987.65,
"heightCm": 987.65,
"heightM": 123.45,
"heightMm": 123.45,
"id": "4",
"innerWallHeightMax": 123.45,
"innerWallHeightMin": 123.45,
"innerWallWidthMax": 987.65,
"innerWallWidthMin": 987.65,
"roofOpeningHeight": 987.65,
"roofOpeningWidth": 123.45,
"widthCm": 123.45,
"widthM": 987.65,
"widthMm": 987.65
}
SolutionProduct
Description
A product being one of the available solutions for a specific product combination.
A SolutionProduct is the same as a usual Product but one that provides an additional list of required other products for that particular combination which this solution has been loaded for (that list is optional and can therefore be empty).
Fields
| Field Name | Description |
|---|---|
addon -
Addon
|
The product's additional products (if set, otherwise null). |
airPermeability -
Int
|
The product's air permeability. |
availableAddons -
[ProductVariant]
|
The product's addon variants. List of product variants of different addon that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDessins -
[ProductVariant]
|
The product's dessin variants. List of product variants of different dessin that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeColors -
[ProductVariant]
|
The product's dome color variants ("clear" / "opaque" / etc.). List of product variants of different dome colors that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeKerbHeights -
[ProductVariant]
|
The product's dome heights variants. List of product variants of different dome heights that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableDomeLayers -
[ProductVariant]
|
The product's dome layers variants. List of product variants of different dome layers that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableExteriors -
[ProductVariant]
|
The product's exterior variants. List of product variants of different exterior finish that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableFlanges -
[ProductVariant]
|
The product's flanges variants. List of product variants of different flanges that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGlazings -
[ProductVariant]
|
The product's glazing variants. List of product variants of different glazing that share the exact same other characteristics with the current product (same size, same interior finish, same exterior finish etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHeights -
[ProductVariant]
|
The product's height variants. List of product variants of different height that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of height variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableHingings -
[ProductVariant]
|
The product's hinging variants. List of product variants of different hinging that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableInteriors -
[ProductVariant]
|
The product's interior variants. List of product variants of different interior finish that share the exact same other characteristics with the current product (same size, same exterior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableLengths -
[ProductVariant]
|
The product's length variants. List of product variants of different length that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of length variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableOperations -
[ProductVariant]
|
The product's operation variants. List of product variants of different operation that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableProductVariants -
[ProductVariant]
|
List of products sharing the exact same characteristics with the current product (e.g. same size, same interior finish, same glazing etc.), see argument same. Or in short: It's listing the product's variants dependant on given characteristics.
Be aware that this field requires you to pass in a country code or a locale to the query to take the market availabilities of the other products into account. |
Arguments
|
|
availableRoofThicknesses -
[ProductVariant]
|
The product's roof thickness variants. List of product variants of different roof thickness that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthVerticals -
[ProductVariant]
|
The product's vertical gutter width variants. List of product variants of different vertical gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableGutterWidthHorizontals -
[ProductVariant]
|
The product's horizontal gutter width variants. List of product variants of different horizontal gutter width that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSiderailcolors -
[ProductVariant]
|
The product's siderailcolor variants. List of product variants of different siderailcolor that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableSizes -
[ProductVariant]
|
The product's size variants. List of product variants of different size that share the exact same other characteristics with the current product (same interior finish, same exterior finish, same glazing etc.). Or in short: This is a list of size variants. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the product variants into account. |
Arguments
|
|
availableTypes -
[ProductVariant]
|
List of products of different product type regardless of their categories (because different window types are usually also categorized differently in the PIM hierarchy) that share the exact same other characteristics with the current product (same size, same interior finish, same glazing etc.). Or in short: It's more or less the product's type variants, so to speak. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of the other products into account. |
Arguments
|
|
bomProducts -
[Product]
|
List of BOM co-products for if the product's isBom flag is TRUE. |
categories -
[Category]
|
The product's categories in hierarchical order. |
category -
Category
|
The product's category. |
combinable -
[CombinableProducts]
|
List of combinable products, optionally filtered by passed type of combination (to filter combinations by "roof terraces only", for example) and/or by passed product type(s). |
Arguments
|
|
combinationSolutions -
[SolutionProduct]
|
The available solution products for a specific product combination.
Due to requirements of VLX-1202 we need to remove this field from products. Use the provided combinationSolution query instead.
|
Arguments
|
|
compatible -
[CompatibleProduct]
|
List of compatible products, optionally filtered by passed type of compatibility (to filter compatibilities by "flashings only", for example) and/or by passed product type(s). |
Arguments
|
|
deliveryTime -
Int
|
The product's delivery time in workdays. |
Arguments
|
|
description -
String!
|
will be removed, use shortCommercialDescription instead
will be removed, use shortCommercialDescription instead
|
descriptionLong -
String!
|
will be removed, use longCommercialDescription instead
will be removed, use longCommercialDescription instead
|
dessin -
Dessin
|
The product's dessin. |
domeColor -
DomeColor
|
The product's dome color (if set, otherwise null). |
domeKerbHeight -
DomeKerbHeight
|
The product's dome kerb height (if set, otherwise null). |
domeLayer -
DomeLayer
|
The product's dome layer name (if set, otherwise null). |
ean -
String!
|
The product's EAN (European Article Number) as set in the PIM. |
effectiveDaylightArea -
Area
|
The product's effective daylight area. |
exterior -
Exterior
|
The product's exterior finish. |
flange -
Flange
|
The product's flange (if set, otherwise null). |
frwCombinations -
[FrwCombination]
|
The product's FRW combinations with other products. |
generation -
ProductGeneration
|
The product generation (e.g. V22). |
glazing -
Glazing
|
The product's glazing. |
gutterWidthVertical -
GutterWidthVertical
|
The product's vertical gutter width (if set, otherwise null). |
gutterWidthHorizontal -
GutterWidthHorizontal
|
The product's horizontal gutter width (if set, otherwise null). |
height -
Height
|
The product's height code (if set, otherwise null). |
hinging -
Hinging
|
The product's hinging (if set, otherwise null). |
id -
ID!
|
The product's ID as used internally in the application-service. |
imagePrimary -
Image
|
The product's primary image. |
imagesSecondary -
[Image]
|
The product's secondary images. |
Arguments
|
|
interior -
Interior
|
The product's interior finish. |
isBom -
Boolean!
|
Determines if this is a BOM product. See also bomProducts. Be aware that the isBom flag is market specific, thus it relies on the country parameter being passed to the query. |
isBurglaryResistant -
Boolean!
|
Determines if this product is burglary resistant. |
isEligible -
Boolean
|
Determines if the product is eligible in the current country (as passed to the query or as passed to this field as argument). You might also be interested in the thermalTransmittance field. |
Arguments
|
|
isProDelivery -
Boolean!
|
Determines if this product supports pro-delivery. |
isProfessionalsProductProgram -
Boolean!
|
Determines if this product is part of the professionals product program for the current country being passed to the query. |
length -
Length
|
The product's length code (if set, otherwise null). |
longCommercialDescription -
String
|
The product's long commercial name as set in the PIM export as Product_LongCommercialDescription. |
longCommercialName -
String!
|
The product's long commercial name as set in the PIM export as Product_LongCommercialName. If the product's long name cannot be found then the VCI will be returned. |
marketIntroduction -
String
|
The product's market introduction date as string.
If the format argument is omitted then the result will be formatted with the default ISO_8601 ("YYYY-MM-DD"). |
Arguments
|
|
materialDescription -
String
|
The product's material description as set in the PIM export as sapMaterialDescription. |
name -
String!
|
will be removed, use shortCommercialName instead
will be removed, use shortCommercialName instead
|
nameLong -
String!
|
will be removed, use longCommercialName instead
will be removed, use longCommercialName instead
|
operation -
Operation
|
The product's operation. |
price -
Price
|
The product's price for given country code. |
Arguments
|
|
prices -
[Price]
|
The product's prices for different countries / markets. |
roofThickness -
RoofThickness
|
The product's roof thickness (if set, otherwise null). |
searchData -
String!
|
JSON formatted string of the search data as sent to the search-service for indexing the product. |
Arguments
|
|
searchTerms -
[String]
|
List of search terms as sent to the search-service for indexing the product. |
Arguments
|
|
shortCommercialDescription -
String
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialDescription |
shortCommercialName -
String!
|
The product's short commercial name as set in the PIM export as Product_ShortCommercialName. If the product's short name cannot be found then the VCE will be returned. |
siderailcolor -
Siderailcolor
|
The product's siderail color. |
size -
Size
|
The product's size. |
soundInsulation -
String
|
The product's sound insulation. |
status -
Int
|
The product's availability status for the current market as being set in the SAP distribution chain specific status field of the PIM. Be aware that this field requires you to pass in a country code to the query to actually determine such a market that the product status has to be returned for. |
thermalTransmittance -
String
|
The product's thermal transmittance. You might also be interested in having a look at the isEligible field. |
totalSolarEnergyTransmittance -
Float
|
The product's total solar energy transmittance. |
translations -
[Translation]
|
Translation entries being related to the product. |
Arguments
|
|
type -
Type
|
The product's type. |
vce -
String!
|
The product's VCE as set in the PIM. |
vci -
String!
|
The product's VCI as set in the PIM. |
additionallyRequired -
[Product]
|
Products that are additionally required for the solution product in respect of the current product combination. Be aware that this field requires you to pass in a country code to the query to take the market availabilities of required products into account. |
Arguments
|
|
additionallyRequiredId -
[ID]
|
Product IDs that are required for the solution. Be aware that this listing does not take into account any market availability. (See also the additionallyRequired` field.) |
Example
{
"addon": Addon,
"airPermeability": 987,
"availableAddons": [ProductVariant],
"availableDessins": [ProductVariant],
"availableDomeColors": [ProductVariant],
"availableDomeKerbHeights": [ProductVariant],
"availableDomeLayers": [ProductVariant],
"availableExteriors": [ProductVariant],
"availableFlanges": [ProductVariant],
"availableGlazings": [ProductVariant],
"availableHeights": [ProductVariant],
"availableHingings": [ProductVariant],
"availableInteriors": [ProductVariant],
"availableLengths": [ProductVariant],
"availableOperations": [ProductVariant],
"availableProductVariants": [ProductVariant],
"availableRoofThicknesses": [ProductVariant],
"availableGutterWidthVerticals": [ProductVariant],
"availableGutterWidthHorizontals": [ProductVariant],
"availableSiderailcolors": [ProductVariant],
"availableSizes": [ProductVariant],
"availableTypes": [ProductVariant],
"bomProducts": [Product],
"categories": [Category],
"category": Category,
"combinable": [CombinableProducts],
"combinationSolutions": [SolutionProduct],
"compatible": [CompatibleProduct],
"deliveryTime": 123,
"description": "xyz789",
"descriptionLong": "xyz789",
"dessin": Dessin,
"domeColor": DomeColor,
"domeKerbHeight": DomeKerbHeight,
"domeLayer": DomeLayer,
"ean": "xyz789",
"effectiveDaylightArea": Area,
"exterior": Exterior,
"flange": Flange,
"frwCombinations": [FrwCombination],
"generation": ProductGeneration,
"glazing": Glazing,
"gutterWidthVertical": GutterWidthVertical,
"gutterWidthHorizontal": GutterWidthHorizontal,
"height": Height,
"hinging": Hinging,
"id": 4,
"imagePrimary": Image,
"imagesSecondary": [Image],
"interior": Interior,
"isBom": true,
"isBurglaryResistant": false,
"isEligible": false,
"isProDelivery": false,
"isProfessionalsProductProgram": true,
"length": Length,
"longCommercialDescription": "abc123",
"longCommercialName": "xyz789",
"marketIntroduction": "xyz789",
"materialDescription": "abc123",
"name": "xyz789",
"nameLong": "abc123",
"operation": Operation,
"price": Price,
"prices": [Price],
"roofThickness": RoofThickness,
"searchData": "abc123",
"searchTerms": ["abc123"],
"shortCommercialDescription": "abc123",
"shortCommercialName": "xyz789",
"siderailcolor": Siderailcolor,
"size": Size,
"soundInsulation": "abc123",
"status": 123,
"thermalTransmittance": "abc123",
"totalSolarEnergyTransmittance": 987.65,
"translations": [Translation],
"type": Type,
"vce": "abc123",
"vci": "abc123",
"additionallyRequired": [Product],
"additionallyRequiredId": ["4"]
}
SolutionType
Description
The solution types of product combinations.
Values
| Enum Value | Description |
|---|---|
|
|
Filters solutions by linings. |
|
|
Filters solutions by flashings. |
|
|
Filters solutions by shutter blinds. |
Example
"LINING_SOLUTIONS"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Translation
Description
An entry's translation of a specific type and locale. The related entry can be anything like a product characteristic or the product itself, for instance.
Fields
| Field Name | Description |
|---|---|
key -
String!
|
The translation entry's access key (e.g. "productName"). |
locale -
String
|
The localization code (like "de-DE", "en-GB", "en-US" etc.) which the value has been associated with. |
value -
String
|
The translation entry's value that has been stored for the current object (may it be a product or a characteristic or whatever else) and type and locale. |
Example
{
"key": "abc123",
"locale": "xyz789",
"value": "xyz789"
}