CPQ Embedded

BrowseMaterials

POST/api/gateway/embedded/browsematerials

Browse for materials using optional filters. Supports filtering by category, supplier, and search term, with paginated results.

Request Body

application/json

Contains the filter criteria such as category ID, supplier ID, search term, and pagination settings.

TypeScript Definitions

Use the request body type in TypeScript.

Represents a request to browse and filter materials within the embedded API. This request allows third-party integrators to retrieve a paginated list of materials by applying optional filters such as category, supplier, and free-text search terms.

categoryId?|

Gets or sets the category identifier used to filter materials by their associated category. When provided, only materials belonging to the specified category are returned. If omitted, materials from all categories are included in the results.

searchTerm?|

Gets or sets the free-text search term used to filter materials by name or description. When provided, only materials whose name or description contains the specified term are returned. The comparison is case-insensitive. If omitted, no text filtering is applied.

supplierId?|

Gets or sets the supplier identifier used to filter materials by their associated supplier. When provided, only materials provided by the specified supplier are returned. If omitted, materials from all suppliers are included in the results.

pageNumber?integer

Gets or sets the page number for paginated results. Page numbers are 1-based. Defaults to 1 if not specified, returning the first page of results.

pageSize?integer

Gets or sets the number of items to return per page. The value must be greater than zero. Defaults to a standard page size if not specified. Page numbers are 1-based.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/embedded/browsematerials" \  -H "Content-Type: application/json" \  -d '{}'

{  "items": [    {      "id": 0,      "code": "string",      "categoryId": 0,      "eanCode": "string",      "supplierCode": "string",      "description": "string",      "remarks": "string",      "promotionPrice": 0,      "salePrice": 0,      "purchasePrice": 0,      "saleQuantity": 0,      "saleUnit": "string",      "leadTime": 0.1,      "imageUrl": "string",      "supplierId": 0,      "supplierName": "string",      "isWage": true,      "color": "string",      "extraFieldValues": [        {          "extraField": 0,          "extraFieldName": "string",          "extraFieldNameResource": "string",          "value": "string",          "valueResource": "string",          "image": "string",          "displayOrder": 0        }      ],      "promotions": [        {          "description": "string",          "categoryLinkNames": [            "string"          ]        }      ],      "materialOptionValues": [        {          "description": "string",          "value": 0        }      ],      "displayProperties": [        {          "description": "string",          "value": "string",          "valueKind": 0        }      ],      "attachments": [        {          "kind": 0,          "path": "string",          "pathKind": 0,          "content": "string"        }      ],      "materialGroups": [        {          "id": 0,          "code": "string",          "description": "string",          "displayOrder": 0,          "image": "string",          "isVisible": true,          "remarks": "string",          "children": [            {              "id": 0,              "code": "string",              "description": "string",              "displayOrder": 0,              "image": "string",              "isVisible": true,              "remarks": "string",              "children": []            }          ]        }      ],      "categoryDescription": "string"    }  ],  "totalItemCount": 0}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

ExportMaterials

GET/api/gateway/embedded/exportmaterials

Exports all materials available to the authorized gateway or embedded user.

Response Body

`application/json`

curl -X GET "https://example.com/api/gateway/embedded/exportmaterials"

{  "items": [    {      "id": 0,      "code": "string",      "categoryId": 0,      "eanCode": "string",      "supplierCode": "string",      "description": "string",      "remarks": "string",      "promotionPrice": 0,      "salePrice": 0,      "purchasePrice": 0,      "saleQuantity": 0,      "saleUnit": "string",      "leadTime": 0.1,      "imageUrl": "string",      "supplierId": 0,      "supplierName": "string",      "isWage": true,      "color": "string",      "extraFieldValues": [        {          "extraField": 0,          "extraFieldName": "string",          "extraFieldNameResource": "string",          "value": "string",          "valueResource": "string",          "image": "string",          "displayOrder": 0        }      ],      "promotions": [        {          "description": "string",          "categoryLinkNames": [            "string"          ]        }      ],      "materialOptionValues": [        {          "description": "string",          "value": 0        }      ],      "displayProperties": [        {          "description": "string",          "value": "string",          "valueKind": 0        }      ],      "attachments": [        {          "kind": 0,          "path": "string",          "pathKind": 0,          "content": "string"        }      ],      "materialGroups": [        {          "id": 0,          "code": "string",          "description": "string",          "displayOrder": 0,          "image": "string",          "isVisible": true,          "remarks": "string",          "children": [            {              "id": 0,              "code": "string",              "description": "string",              "displayOrder": 0,              "image": "string",              "isVisible": true,              "remarks": "string",              "children": []            }          ]        }      ],      "categoryDescription": "string"    }  ],  "totalItemCount": 0}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

GetAllSuppliers

GET/api/gateway/embedded/getallsuppliers

Gets all suppliers available to the current licensee.

Response Body

`application/json`

curl -X GET "https://example.com/api/gateway/embedded/getallsuppliers"

[  {    "id": 0,    "sbnid": 0,    "searchName": "string",    "shortName": "string",    "name": "string"  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

GetMaterialCategories

GET/api/gateway/embedded/getmaterialcategories

Gets selectable categories for the current licensee and language. Categories are used to filter materials during browsing.

Response Body

`application/json`

curl -X GET "https://example.com/api/gateway/embedded/getmaterialcategories"

[  {    "id": 0,    "description": "string",    "interfaceKey": "string"  }]

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

LoadProject

POST/api/gateway/embedded/loadproject

Loads a stored project using the provided data.

Request Body

application/json

Contains information about the project to load.

TypeScript Definitions

Use the request body type in TypeScript.

Contains information about the project to load.

projectId?integer

Gets or sets the project id of the project to load.

includePurchasePrices?|

Optional parameter to include the purchase prices in the project. This is only valid for users with embedded rights.

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/embedded/loadproject" \  -H "Content-Type: application/json" \  -d '{}'

{  "applicationId": 0,  "id": 0,  "referenceId": "string",  "projectNumber": "string",  "reference": "string",  "description": "string",  "externalProjectReference": "string",  "remarks": "string",  "created": "2019-08-24T14:15:22Z",  "lastOpened": "2019-08-24T14:15:22Z",  "lastModified": "2019-08-24T14:15:22Z",  "projectStatus": 0,  "deliveryRef": "string",  "polygons": [    {      "id": 0,      "polygonNumber": "string",      "polygonNumberGrouped": "string",      "purchaseNumber": "string",      "productCategoryId": 0,      "categoryGroupId": 0,      "productCategoryInterfaceKey": "string",      "description": "string",      "width": 0,      "height": 0,      "isDescriptionEnabled": true,      "isHeightEnabled": true,      "isWidthEnabled": true,      "isReadOnly": true,      "isTemporary": true,      "lineNumber": 0,      "modelId": 0,      "modelCode": "string",      "materialId": 0,      "modelDescription": "string",      "modelImageUrl": "string",      "modelInterfaceKey": "string",      "statusValue": 0,      "statusDateTime": "2019-08-24T14:15:22Z",      "statusDescription": "string",      "categoryLinks": [        {          "id": 0,          "interfaceKey": "string",          "childCategoryId": 0,          "parentCategoryId": 0,          "childCategoryDescription": "string",          "isMainCategory": true,          "description": "string",          "quantityDescription": "string",          "remarks": "string",          "imageUrl": "string",          "showMaterialSalePrice": true,          "categoryLinkMaterial": {            "materialCode": "string",            "materialEanCode": "string",            "materialId": 0,            "materialDescription": "string",            "materialColor": "string",            "materialRemarks": "string",            "materialComposition": "string",            "materialSalePrice": 0,            "saleQuantity": 0,            "saleUnit": "string",            "price": {              "totalPrice": 0.1,              "totalPriceBeforePromotions": 0.1,              "priceGroups": [                {                  "code": "string",                  "description": "string",                  "displayOrder": 0,                  "elements": [                    {                      "code": "string",                      "quantity": 0.1,                      "description": "string",                      "unit": "string",                      "unitPriceBeforePromotion": 0.1,                      "unitPrice": 0.1,                      "totalPrice": 0.1,                      "totalPriceBeforePromotion": 0.1,                      "sbnid": 0,                      "purchasePriceInfo": {                        "unitPurchasePrice": 0,                        "totalPurchasePrice": 0                      }                    }                  ]                }              ],              "promotions": [                {                  "code": "string",                  "description": "string",                  "reference": "string",                  "priceDiscount": 0.1,                  "validUntil": "2019-08-24T14:15:22Z"                }              ],              "discountAmount": 0.1,              "totalPurchasePrice": 0.1            },            "extraFieldValues": [              {                "extraField": 0,                "extraFieldName": "string",                "extraFieldNameResource": "string",                "value": "string",                "valueResource": "string",                "image": "string",                "displayOrder": 0              }            ],            "materialOptionValues": [              {                "description": "string",                "value": 0              }            ],            "materialProperties": [              {                "description": "string",                "value": "string",                "valueKind": 0              }            ],            "properties": [              {                "id": 0,                "interfaceKey": "string",                "propertyId": 0,                "dataType": 0,                "description": "string",                "hasDynamicDescription": true,                "isModified": true,                "isModifiedByApp": true,                "isReadOnly": true,                "isRequired": true,                "value": "string",                "displayLabel": "string",                "displayOrder": 0,                "displaySuffix": "string",                "remarks": "string",                "controlType": 0,                "listValues": [                  {                    "interfaceKey": "string",                    "description": "string",                    "value": "string",                    "remarks": "string",                    "imageUrl": "string"                  }                ],                "isVisible": true,                "exclude": true              }            ],            "messages": [              {                "scope": 0,                "context": 0,                "contextReference": "string",                "kind": 0,                "origin": 0,                "text": "string"              }            ],            "supplier": {              "id": 0,              "sbnid": 0,              "searchName": "string",              "shortName": "string",              "name": "string"            },            "redistributionInfo": "string"          },          "statuses": [            {              "id": 0,              "assignedAt": "2019-08-24T14:15:22Z",              "statusId": 0,              "remarks": "string",              "supplierOrderNumber": "string",              "deliveryDate": "2019-08-24T14:15:22Z"            }          ],          "requiredLevel": 0,          "isEnabled": true,          "categoryMaterialOptionFilter": 0        }      ],      "prices": {        "totalPrice": 0.1,        "totalPriceBeforePromotions": 0.1,        "priceGroups": [          {            "code": "string",            "description": "string",            "displayOrder": 0,            "elements": [              {                "code": "string",                "quantity": 0.1,                "description": "string",                "unit": "string",                "unitPriceBeforePromotion": 0.1,                "unitPrice": 0.1,                "totalPrice": 0.1,                "totalPriceBeforePromotion": 0.1,                "sbnid": 0,                "purchasePriceInfo": {                  "unitPurchasePrice": 0,                  "totalPurchasePrice": 0                }              }            ]          }        ],        "promotions": [          {            "code": "string",            "description": "string",            "reference": "string",            "priceDiscount": 0.1,            "validUntil": "2019-08-24T14:15:22Z"          }        ],        "discountAmount": 0.1,        "totalPurchasePrice": 0.1      },      "leadTime": 0.1,      "visualGroups": [        {          "description": "string",          "remarks": "string",          "scenes": [            {              "name": "string",              "visuals": [                {                  "name": "string",                  "url": "string",                  "remarks": "string"                }              ]            }          ]        }      ],      "printDataProperties": [        {          "description": "string",          "value": "string",          "valueKind": 0        }      ],      "documentations": [        {          "documentationKind": 0,          "mediaType": 0,          "description": "string",          "documentationUrl": "string"        }      ],      "polygonStatuses": [        {          "statusValue": 0,          "statusDateTime": "2019-08-24T14:15:22Z",          "statusDescription": "string",          "remarks": "string"        }      ],      "referenceId": "string",      "polygonTypeId": 0,      "polygonTypeCode": "string",      "chainedChildren": [        {          "id": 0,          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "purchaseNumber": "string",          "productCategoryId": 0,          "categoryGroupId": 0,          "productCategoryInterfaceKey": "string",          "description": "string",          "width": 0,          "height": 0,          "isDescriptionEnabled": true,          "isHeightEnabled": true,          "isWidthEnabled": true,          "isReadOnly": true,          "isTemporary": true,          "lineNumber": 0,          "modelId": 0,          "modelCode": "string",          "materialId": 0,          "modelDescription": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "statusValue": 0,          "statusDateTime": "2019-08-24T14:15:22Z",          "statusDescription": "string",          "categoryLinks": [            {              "id": 0,              "interfaceKey": "string",              "childCategoryId": 0,              "parentCategoryId": 0,              "childCategoryDescription": "string",              "isMainCategory": true,              "description": "string",              "quantityDescription": "string",              "remarks": "string",              "imageUrl": "string",              "showMaterialSalePrice": true,              "categoryLinkMaterial": {                "materialCode": "string",                "materialEanCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "saleUnit": "string",                "price": {                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "quantity": 0.1,                          "description": "string",                          "unit": "string",                          "unitPriceBeforePromotion": 0.1,                          "unitPrice": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "sbnid": 0,                          "purchasePriceInfo": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          }                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "reference": "string",                      "priceDiscount": 0.1,                      "validUntil": "2019-08-24T14:15:22Z"                    }                  ],                  "discountAmount": 0.1,                  "totalPurchasePrice": 0.1                },                "extraFieldValues": [                  {                    "extraField": 0,                    "extraFieldName": "string",                    "extraFieldNameResource": "string",                    "value": "string",                    "valueResource": "string",                    "image": "string",                    "displayOrder": 0                  }                ],                "materialOptionValues": [                  {                    "description": "string",                    "value": 0                  }                ],                "materialProperties": [                  {                    "description": "string",                    "value": "string",                    "valueKind": 0                  }                ],                "properties": [                  {                    "id": 0,                    "interfaceKey": "string",                    "propertyId": 0,                    "dataType": 0,                    "description": "string",                    "hasDynamicDescription": true,                    "isModified": true,                    "isModifiedByApp": true,                    "isReadOnly": true,                    "isRequired": true,                    "value": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "remarks": "string",                    "controlType": 0,                    "listValues": [                      {                        "interfaceKey": "string",                        "description": "string",                        "value": "string",                        "remarks": "string",                        "imageUrl": "string"                      }                    ],                    "isVisible": true,                    "exclude": true                  }                ],                "messages": [                  {                    "scope": 0,                    "context": 0,                    "contextReference": "string",                    "kind": 0,                    "origin": 0,                    "text": "string"                  }                ],                "supplier": {                  "id": 0,                  "sbnid": 0,                  "searchName": "string",                  "shortName": "string",                  "name": "string"                },                "redistributionInfo": "string"              },              "statuses": [                {                  "id": 0,                  "assignedAt": "2019-08-24T14:15:22Z",                  "statusId": 0,                  "remarks": "string",                  "supplierOrderNumber": "string",                  "deliveryDate": "2019-08-24T14:15:22Z"                }              ],              "requiredLevel": 0,              "isEnabled": true,              "categoryMaterialOptionFilter": 0            }          ],          "prices": {            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "quantity": 0.1,                    "description": "string",                    "unit": "string",                    "unitPriceBeforePromotion": 0.1,                    "unitPrice": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "sbnid": 0,                    "purchasePriceInfo": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    }                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "reference": "string",                "priceDiscount": 0.1,                "validUntil": "2019-08-24T14:15:22Z"              }            ],            "discountAmount": 0.1,            "totalPurchasePrice": 0.1          },          "leadTime": 0.1,          "visualGroups": [            {              "description": "string",              "remarks": "string",              "scenes": [                {                  "name": "string",                  "visuals": [                    {                      "name": "string",                      "url": "string",                      "remarks": "string"                    }                  ]                }              ]            }          ],          "printDataProperties": [            {              "description": "string",              "value": "string",              "valueKind": 0            }          ],          "documentations": [            {              "documentationKind": 0,              "mediaType": 0,              "description": "string",              "documentationUrl": "string"            }          ],          "polygonStatuses": [            {              "statusValue": 0,              "statusDateTime": "2019-08-24T14:15:22Z",              "statusDescription": "string",              "remarks": "string"            }          ],          "referenceId": "string",          "polygonTypeId": 0,          "polygonTypeCode": "string",          "chainedChildren": [],          "children": [            {              "id": 0,              "polygonNumber": "string",              "polygonNumberGrouped": "string",              "purchaseNumber": "string",              "productCategoryId": 0,              "categoryGroupId": 0,              "productCategoryInterfaceKey": "string",              "description": "string",              "width": 0,              "height": 0,              "isDescriptionEnabled": true,              "isHeightEnabled": true,              "isWidthEnabled": true,              "isReadOnly": true,              "isTemporary": true,              "lineNumber": 0,              "modelId": 0,              "modelCode": "string",              "materialId": 0,              "modelDescription": "string",              "modelImageUrl": "string",              "modelInterfaceKey": "string",              "statusValue": 0,              "statusDateTime": "2019-08-24T14:15:22Z",              "statusDescription": "string",              "categoryLinks": [                {                  "id": 0,                  "interfaceKey": "string",                  "childCategoryId": 0,                  "parentCategoryId": 0,                  "childCategoryDescription": "string",                  "isMainCategory": true,                  "description": "string",                  "quantityDescription": "string",                  "remarks": "string",                  "imageUrl": "string",                  "showMaterialSalePrice": true,                  "categoryLinkMaterial": {                    "materialCode": "string",                    "materialEanCode": "string",                    "materialId": 0,                    "materialDescription": "string",                    "materialColor": "string",                    "materialRemarks": "string",                    "materialComposition": "string",                    "materialSalePrice": 0,                    "saleQuantity": 0,                    "saleUnit": "string",                    "price": {                      "totalPrice": 0.1,                      "totalPriceBeforePromotions": 0.1,                      "priceGroups": [                        {                          "code": "string",                          "description": "string",                          "displayOrder": 0,                          "elements": [                            {}                          ]                        }                      ],                      "promotions": [                        {                          "code": "string",                          "description": "string",                          "reference": "string",                          "priceDiscount": 0.1,                          "validUntil": "2019-08-24T14:15:22Z"                        }                      ],                      "discountAmount": 0.1,                      "totalPurchasePrice": 0.1                    },                    "extraFieldValues": [                      {                        "extraField": 0,                        "extraFieldName": "string",                        "extraFieldNameResource": "string",                        "value": "string",                        "valueResource": "string",                        "image": "string",                        "displayOrder": 0                      }                    ],                    "materialOptionValues": [                      {                        "description": "string",                        "value": 0                      }                    ],                    "materialProperties": [                      {                        "description": "string",                        "value": "string",                        "valueKind": 0                      }                    ],                    "properties": [                      {                        "id": 0,                        "interfaceKey": "string",                        "propertyId": 0,                        "dataType": 0,                        "description": "string",                        "hasDynamicDescription": true,                        "isModified": true,                        "isModifiedByApp": true,                        "isReadOnly": true,                        "isRequired": true,                        "value": "string",                        "displayLabel": "string",                        "displayOrder": 0,                        "displaySuffix": "string",                        "remarks": "string",                        "controlType": 0,                        "listValues": [                          {                            "interfaceKey": "string",                            "description": "string",                            "value": "string",                            "remarks": "string",                            "imageUrl": "string"                          }                        ],                        "isVisible": true,                        "exclude": true                      }                    ],                    "messages": [                      {                        "scope": 0,                        "context": 0,                        "contextReference": "string",                        "kind": 0,                        "origin": 0,                        "text": "string"                      }                    ],                    "supplier": {                      "id": 0,                      "sbnid": 0,                      "searchName": "string",                      "shortName": "string",                      "name": "string"                    },                    "redistributionInfo": "string"                  },                  "statuses": [                    {                      "id": 0,                      "assignedAt": "2019-08-24T14:15:22Z",                      "statusId": 0,                      "remarks": "string",                      "supplierOrderNumber": "string",                      "deliveryDate": "2019-08-24T14:15:22Z"                    }                  ],                  "requiredLevel": 0,                  "isEnabled": true,                  "categoryMaterialOptionFilter": 0                }              ],              "prices": {                "totalPrice": 0.1,                "totalPriceBeforePromotions": 0.1,                "priceGroups": [                  {                    "code": "string",                    "description": "string",                    "displayOrder": 0,                    "elements": [                      {                        "code": "string",                        "quantity": 0.1,                        "description": "string",                        "unit": "string",                        "unitPriceBeforePromotion": 0.1,                        "unitPrice": 0.1,                        "totalPrice": 0.1,                        "totalPriceBeforePromotion": 0.1,                        "sbnid": 0,                        "purchasePriceInfo": {                          "unitPurchasePrice": 0,                          "totalPurchasePrice": 0                        }                      }                    ]                  }                ],                "promotions": [                  {                    "code": "string",                    "description": "string",                    "reference": "string",                    "priceDiscount": 0.1,                    "validUntil": "2019-08-24T14:15:22Z"                  }                ],                "discountAmount": 0.1,                "totalPurchasePrice": 0.1              },              "leadTime": 0.1,              "visualGroups": [                {                  "description": "string",                  "remarks": "string",                  "scenes": [                    {                      "name": "string",                      "visuals": [                        {                          "name": "string",                          "url": "string",                          "remarks": "string"                        }                      ]                    }                  ]                }              ],              "printDataProperties": [                {                  "description": "string",                  "value": "string",                  "valueKind": 0                }              ],              "documentations": [                {                  "documentationKind": 0,                  "mediaType": 0,                  "description": "string",                  "documentationUrl": "string"                }              ],              "polygonStatuses": [                {                  "statusValue": 0,                  "statusDateTime": "2019-08-24T14:15:22Z",                  "statusDescription": "string",                  "remarks": "string"                }              ],              "referenceId": "string",              "polygonTypeId": 0,              "polygonTypeCode": "string",              "chainedChildren": [],              "children": [],              "parentPolygonId": 0,              "categoryFavoriteId": 0,              "categoryFavoriteDescription": "string",              "categoryFavoriteCode": "string",              "grossHeight": 0,              "grossWidth": 0,              "widthCorrection": 0,              "heightCorrection": 0,              "categoryPresetId": 0,              "dimensionsInfo": {                "minWidth": 0,                "maxWidth": 0,                "minHeight": 0,                "maxHeight": 0,                "area": 0,                "seamLength": 0.1,                "circumference": 0,                "circumferenceWithoutDoors": 0              },              "attributes": {                "property1": "string",                "property2": "string"              },              "answers": [                {                  "id": 0,                  "answerId": 0,                  "answerCode": "string"                }              ],              "vertices": [                {                  "id": 0,                  "kind": 0,                  "x": 0,                  "y": 0                }              ],              "layDirection": 0,              "generateLatitudinalSeams": true            }          ],          "parentPolygonId": 0,          "categoryFavoriteId": 0,          "categoryFavoriteDescription": "string",          "categoryFavoriteCode": "string",          "grossHeight": 0,          "grossWidth": 0,          "widthCorrection": 0,          "heightCorrection": 0,          "categoryPresetId": 0,          "dimensionsInfo": {            "minWidth": 0,            "maxWidth": 0,            "minHeight": 0,            "maxHeight": 0,            "area": 0,            "seamLength": 0.1,            "circumference": 0,            "circumferenceWithoutDoors": 0          },          "attributes": {            "property1": "string",            "property2": "string"          },          "answers": [            {              "id": 0,              "answerId": 0,              "answerCode": "string"            }          ],          "vertices": [            {              "id": 0,              "kind": 0,              "x": 0,              "y": 0            }          ],          "layDirection": 0,          "generateLatitudinalSeams": true        }      ],      "children": [        {          "id": 0,          "polygonNumber": "string",          "polygonNumberGrouped": "string",          "purchaseNumber": "string",          "productCategoryId": 0,          "categoryGroupId": 0,          "productCategoryInterfaceKey": "string",          "description": "string",          "width": 0,          "height": 0,          "isDescriptionEnabled": true,          "isHeightEnabled": true,          "isWidthEnabled": true,          "isReadOnly": true,          "isTemporary": true,          "lineNumber": 0,          "modelId": 0,          "modelCode": "string",          "materialId": 0,          "modelDescription": "string",          "modelImageUrl": "string",          "modelInterfaceKey": "string",          "statusValue": 0,          "statusDateTime": "2019-08-24T14:15:22Z",          "statusDescription": "string",          "categoryLinks": [            {              "id": 0,              "interfaceKey": "string",              "childCategoryId": 0,              "parentCategoryId": 0,              "childCategoryDescription": "string",              "isMainCategory": true,              "description": "string",              "quantityDescription": "string",              "remarks": "string",              "imageUrl": "string",              "showMaterialSalePrice": true,              "categoryLinkMaterial": {                "materialCode": "string",                "materialEanCode": "string",                "materialId": 0,                "materialDescription": "string",                "materialColor": "string",                "materialRemarks": "string",                "materialComposition": "string",                "materialSalePrice": 0,                "saleQuantity": 0,                "saleUnit": "string",                "price": {                  "totalPrice": 0.1,                  "totalPriceBeforePromotions": 0.1,                  "priceGroups": [                    {                      "code": "string",                      "description": "string",                      "displayOrder": 0,                      "elements": [                        {                          "code": "string",                          "quantity": 0.1,                          "description": "string",                          "unit": "string",                          "unitPriceBeforePromotion": 0.1,                          "unitPrice": 0.1,                          "totalPrice": 0.1,                          "totalPriceBeforePromotion": 0.1,                          "sbnid": 0,                          "purchasePriceInfo": {                            "unitPurchasePrice": 0,                            "totalPurchasePrice": 0                          }                        }                      ]                    }                  ],                  "promotions": [                    {                      "code": "string",                      "description": "string",                      "reference": "string",                      "priceDiscount": 0.1,                      "validUntil": "2019-08-24T14:15:22Z"                    }                  ],                  "discountAmount": 0.1,                  "totalPurchasePrice": 0.1                },                "extraFieldValues": [                  {                    "extraField": 0,                    "extraFieldName": "string",                    "extraFieldNameResource": "string",                    "value": "string",                    "valueResource": "string",                    "image": "string",                    "displayOrder": 0                  }                ],                "materialOptionValues": [                  {                    "description": "string",                    "value": 0                  }                ],                "materialProperties": [                  {                    "description": "string",                    "value": "string",                    "valueKind": 0                  }                ],                "properties": [                  {                    "id": 0,                    "interfaceKey": "string",                    "propertyId": 0,                    "dataType": 0,                    "description": "string",                    "hasDynamicDescription": true,                    "isModified": true,                    "isModifiedByApp": true,                    "isReadOnly": true,                    "isRequired": true,                    "value": "string",                    "displayLabel": "string",                    "displayOrder": 0,                    "displaySuffix": "string",                    "remarks": "string",                    "controlType": 0,                    "listValues": [                      {                        "interfaceKey": "string",                        "description": "string",                        "value": "string",                        "remarks": "string",                        "imageUrl": "string"                      }                    ],                    "isVisible": true,                    "exclude": true                  }                ],                "messages": [                  {                    "scope": 0,                    "context": 0,                    "contextReference": "string",                    "kind": 0,                    "origin": 0,                    "text": "string"                  }                ],                "supplier": {                  "id": 0,                  "sbnid": 0,                  "searchName": "string",                  "shortName": "string",                  "name": "string"                },                "redistributionInfo": "string"              },              "statuses": [                {                  "id": 0,                  "assignedAt": "2019-08-24T14:15:22Z",                  "statusId": 0,                  "remarks": "string",                  "supplierOrderNumber": "string",                  "deliveryDate": "2019-08-24T14:15:22Z"                }              ],              "requiredLevel": 0,              "isEnabled": true,              "categoryMaterialOptionFilter": 0            }          ],          "prices": {            "totalPrice": 0.1,            "totalPriceBeforePromotions": 0.1,            "priceGroups": [              {                "code": "string",                "description": "string",                "displayOrder": 0,                "elements": [                  {                    "code": "string",                    "quantity": 0.1,                    "description": "string",                    "unit": "string",                    "unitPriceBeforePromotion": 0.1,                    "unitPrice": 0.1,                    "totalPrice": 0.1,                    "totalPriceBeforePromotion": 0.1,                    "sbnid": 0,                    "purchasePriceInfo": {                      "unitPurchasePrice": 0,                      "totalPurchasePrice": 0                    }                  }                ]              }            ],            "promotions": [              {                "code": "string",                "description": "string",                "reference": "string",                "priceDiscount": 0.1,                "validUntil": "2019-08-24T14:15:22Z"              }            ],            "discountAmount": 0.1,            "totalPurchasePrice": 0.1          },          "leadTime": 0.1,          "visualGroups": [            {              "description": "string",              "remarks": "string",              "scenes": [                {                  "name": "string",                  "visuals": [                    {                      "name": "string",                      "url": "string",                      "remarks": "string"                    }                  ]                }              ]            }          ],          "printDataProperties": [            {              "description": "string",              "value": "string",              "valueKind": 0            }          ],          "documentations": [            {              "documentationKind": 0,              "mediaType": 0,              "description": "string",              "documentationUrl": "string"            }          ],          "polygonStatuses": [            {              "statusValue": 0,              "statusDateTime": "2019-08-24T14:15:22Z",              "statusDescription": "string",              "remarks": "string"            }          ],          "referenceId": "string",          "polygonTypeId": 0,          "polygonTypeCode": "string",          "chainedChildren": [            {              "id": 0,              "polygonNumber": "string",              "polygonNumberGrouped": "string",              "purchaseNumber": "string",              "productCategoryId": 0,              "categoryGroupId": 0,              "productCategoryInterfaceKey": "string",              "description": "string",              "width": 0,              "height": 0,              "isDescriptionEnabled": true,              "isHeightEnabled": true,              "isWidthEnabled": true,              "isReadOnly": true,              "isTemporary": true,              "lineNumber": 0,              "modelId": 0,              "modelCode": "string",              "materialId": 0,              "modelDescription": "string",              "modelImageUrl": "string",              "modelInterfaceKey": "string",              "statusValue": 0,              "statusDateTime": "2019-08-24T14:15:22Z",              "statusDescription": "string",              "categoryLinks": [                {                  "id": 0,                  "interfaceKey": "string",                  "childCategoryId": 0,                  "parentCategoryId": 0,                  "childCategoryDescription": "string",                  "isMainCategory": true,                  "description": "string",                  "quantityDescription": "string",                  "remarks": "string",                  "imageUrl": "string",                  "showMaterialSalePrice": true,                  "categoryLinkMaterial": {                    "materialCode": "string",                    "materialEanCode": "string",                    "materialId": 0,                    "materialDescription": "string",                    "materialColor": "string",                    "materialRemarks": "string",                    "materialComposition": "string",                    "materialSalePrice": 0,                    "saleQuantity": 0,                    "saleUnit": "string",                    "price": {                      "totalPrice": 0.1,                      "totalPriceBeforePromotions": 0.1,                      "priceGroups": [                        {                          "code": "string",                          "description": "string",                          "displayOrder": 0,                          "elements": [                            {}                          ]                        }                      ],                      "promotions": [                        {                          "code": "string",                          "description": "string",                          "reference": "string",                          "priceDiscount": 0.1,                          "validUntil": "2019-08-24T14:15:22Z"                        }                      ],                      "discountAmount": 0.1,                      "totalPurchasePrice": 0.1                    },                    "extraFieldValues": [                      {                        "extraField": 0,                        "extraFieldName": "string",                        "extraFieldNameResource": "string",                        "value": "string",                        "valueResource": "string",                        "image": "string",                        "displayOrder": 0                      }                    ],                    "materialOptionValues": [                      {                        "description": "string",                        "value": 0                      }                    ],                    "materialProperties": [                      {                        "description": "string",                        "value": "string",                        "valueKind": 0                      }                    ],                    "properties": [                      {                        "id": 0,                        "interfaceKey": "string",                        "propertyId": 0,                        "dataType": 0,                        "description": "string",                        "hasDynamicDescription": true,                        "isModified": true,                        "isModifiedByApp": true,                        "isReadOnly": true,                        "isRequired": true,                        "value": "string",                        "displayLabel": "string",                        "displayOrder": 0,                        "displaySuffix": "string",                        "remarks": "string",                        "controlType": 0,                        "listValues": [                          {                            "interfaceKey": "string",                            "description": "string",                            "value": "string",                            "remarks": "string",                            "imageUrl": "string"                          }                        ],                        "isVisible": true,                        "exclude": true                      }                    ],                    "messages": [                      {                        "scope": 0,                        "context": 0,                        "contextReference": "string",                        "kind": 0,                        "origin": 0,                        "text": "string"                      }                    ],                    "supplier": {                      "id": 0,                      "sbnid": 0,                      "searchName": "string",                      "shortName": "string",                      "name": "string"                    },                    "redistributionInfo": "string"                  },                  "statuses": [                    {                      "id": 0,                      "assignedAt": "2019-08-24T14:15:22Z",                      "statusId": 0,                      "remarks": "string",                      "supplierOrderNumber": "string",                      "deliveryDate": "2019-08-24T14:15:22Z"                    }                  ],                  "requiredLevel": 0,                  "isEnabled": true,                  "categoryMaterialOptionFilter": 0                }              ],              "prices": {                "totalPrice": 0.1,                "totalPriceBeforePromotions": 0.1,                "priceGroups": [                  {                    "code": "string",                    "description": "string",                    "displayOrder": 0,                    "elements": [                      {                        "code": "string",                        "quantity": 0.1,                        "description": "string",                        "unit": "string",                        "unitPriceBeforePromotion": 0.1,                        "unitPrice": 0.1,                        "totalPrice": 0.1,                        "totalPriceBeforePromotion": 0.1,                        "sbnid": 0,                        "purchasePriceInfo": {                          "unitPurchasePrice": 0,                          "totalPurchasePrice": 0                        }                      }                    ]                  }                ],                "promotions": [                  {                    "code": "string",                    "description": "string",                    "reference": "string",                    "priceDiscount": 0.1,                    "validUntil": "2019-08-24T14:15:22Z"                  }                ],                "discountAmount": 0.1,                "totalPurchasePrice": 0.1              },              "leadTime": 0.1,              "visualGroups": [                {                  "description": "string",                  "remarks": "string",                  "scenes": [                    {                      "name": "string",                      "visuals": [                        {                          "name": "string",                          "url": "string",                          "remarks": "string"                        }                      ]                    }                  ]                }              ],              "printDataProperties": [                {                  "description": "string",                  "value": "string",                  "valueKind": 0                }              ],              "documentations": [                {                  "documentationKind": 0,                  "mediaType": 0,                  "description": "string",                  "documentationUrl": "string"                }              ],              "polygonStatuses": [                {                  "statusValue": 0,                  "statusDateTime": "2019-08-24T14:15:22Z",                  "statusDescription": "string",                  "remarks": "string"                }              ],              "referenceId": "string",              "polygonTypeId": 0,              "polygonTypeCode": "string",              "chainedChildren": [],              "children": [],              "parentPolygonId": 0,              "categoryFavoriteId": 0,              "categoryFavoriteDescription": "string",              "categoryFavoriteCode": "string",              "grossHeight": 0,              "grossWidth": 0,              "widthCorrection": 0,              "heightCorrection": 0,              "categoryPresetId": 0,              "dimensionsInfo": {                "minWidth": 0,                "maxWidth": 0,                "minHeight": 0,                "maxHeight": 0,                "area": 0,                "seamLength": 0.1,                "circumference": 0,                "circumferenceWithoutDoors": 0              },              "attributes": {                "property1": "string",                "property2": "string"              },              "answers": [                {                  "id": 0,                  "answerId": 0,                  "answerCode": "string"                }              ],              "vertices": [                {                  "id": 0,                  "kind": 0,                  "x": 0,                  "y": 0                }              ],              "layDirection": 0,              "generateLatitudinalSeams": true            }          ],          "children": [],          "parentPolygonId": 0,          "categoryFavoriteId": 0,          "categoryFavoriteDescription": "string",          "categoryFavoriteCode": "string",          "grossHeight": 0,          "grossWidth": 0,          "widthCorrection": 0,          "heightCorrection": 0,          "categoryPresetId": 0,          "dimensionsInfo": {            "minWidth": 0,            "maxWidth": 0,            "minHeight": 0,            "maxHeight": 0,            "area": 0,            "seamLength": 0.1,            "circumference": 0,            "circumferenceWithoutDoors": 0          },          "attributes": {            "property1": "string",            "property2": "string"          },          "answers": [            {              "id": 0,              "answerId": 0,              "answerCode": "string"            }          ],          "vertices": [            {              "id": 0,              "kind": 0,              "x": 0,              "y": 0            }          ],          "layDirection": 0,          "generateLatitudinalSeams": true        }      ],      "parentPolygonId": 0,      "categoryFavoriteId": 0,      "categoryFavoriteDescription": "string",      "categoryFavoriteCode": "string",      "grossHeight": 0,      "grossWidth": 0,      "widthCorrection": 0,      "heightCorrection": 0,      "categoryPresetId": 0,      "dimensionsInfo": {        "minWidth": 0,        "maxWidth": 0,        "minHeight": 0,        "maxHeight": 0,        "area": 0,        "seamLength": 0.1,        "circumference": 0,        "circumferenceWithoutDoors": 0      },      "attributes": {        "property1": "string",        "property2": "string"      },      "answers": [        {          "id": 0,          "answerId": 0,          "answerCode": "string"        }      ],      "vertices": [        {          "id": 0,          "kind": 0,          "x": 0,          "y": 0        }      ],      "layDirection": 0,      "generateLatitudinalSeams": true    }  ],  "price": {    "totalPrice": 0.1,    "totalPriceBeforePromotions": 0.1,    "priceGroups": [      {        "code": "string",        "description": "string",        "displayOrder": 0,        "elements": [          {            "code": "string",            "quantity": 0.1,            "description": "string",            "unit": "string",            "unitPriceBeforePromotion": 0.1,            "unitPrice": 0.1,            "totalPrice": 0.1,            "totalPriceBeforePromotion": 0.1,            "sbnid": 0,            "purchasePriceInfo": {              "unitPurchasePrice": 0,              "totalPurchasePrice": 0            }          }        ]      }    ],    "promotions": [      {        "code": "string",        "description": "string",        "reference": "string",        "priceDiscount": 0.1,        "validUntil": "2019-08-24T14:15:22Z"      }    ],    "discountAmount": 0.1,    "totalPurchasePrice": 0.1  },  "customerId": 0,  "customerDebtorCode": "string",  "executionAddress": {    "name": "string",    "street": "string",    "streetNumber": "string",    "zip": "string",    "city": "string",    "countryCode": "string",    "phoneNumber": "string",    "emailAddress": "string",    "contactName": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "deliveryAddress": {    "name": "string",    "street": "string",    "streetNumber": "string",    "zip": "string",    "city": "string",    "countryCode": "string",    "phoneNumber": "string",    "emailAddress": "string",    "contactName": "string",    "extraAddressLine": "string",    "extraAddressLine2": "string",    "state": "string"  },  "discountVouchers": [    "string"  ],  "projectDiscounts": [    {      "id": 0,      "code": "string",      "amount": 0.1,      "description": "string",      "discountType": 1,      "percentage": 0,      "dateActivated": "2019-08-24T14:15:22Z"    }  ],  "projectSets": [    {      "id": 0,      "setDefinitionId": 0,      "setDefinitionCode": "string",      "displayOrder": 0,      "projectSetPolygons": [        {          "id": 0,          "polygonId": 0        }      ]    }  ]}

Empty

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

SendProject

POST/api/gateway/embedded/sendproject

Sends the project to manufacturing.

Request Body

application/json

Contains information about the project that is sent, including customer details, reference, and delivery address settings.

TypeScript Definitions

Use the request body type in TypeScript.

Contains the information about the project to send.

projectId?integer

Gets or sets the project id of the project to send.

customer?

Set the customer data to use for this project. This will insert a new customer if the Customer.Id == 0 or update an existing customer. This is optional, for when the project does not have a customer yet for example.

reference?|

The reference of the project. When left as null or empty, the customer name will automatically be used for this field on the project.

setDeliveryAddress?boolean

If set to true, will use the customer address as delivery address. If the customer delivery address is filled, that will be used instead of

Response Body

`application/json`

curl -X POST "https://example.com/api/gateway/embedded/sendproject" \  -H "Content-Type: application/json" \  -d '{}'

true

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "extensions": {    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

204

400application/json

defaultapplication/json

200application/json

400application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`