Create Designs

Create Designs Endpoint

To successfully create a Design for a single or multiple locations the following endpoint can be used:

Endpoint:
https://api.novasole.com/designs/create

Request Method:
POST

Request Body

The request body includes details about the Location, Energy Scenario, and Customer. Not all parameters are required and can be set to null.

Currently, only locations in the Netherlands, Belgium, and Denmark are supported. Belgian addresses require a street property, while Dutch addresses need a postal code.

The Energy Scenario defines user preferences for creating an energy system, including preferred products and electricity usage details.

To get a valid Campaign Id, use the Get Campaign Info endpoint or contact Support support@novasole.com if you need a specific Package Id or Module Id.

For multiple designs repeat the input model in the models list property. Be aware that multiple models in a single request could take longer than single models in multiple requests.

{
  "models": [
    {
      "location": {
        "address": {
          "postalCode": "1234AB",
          "houseNumber": 1,
          "additive": null,
          "street": null,
          "place": null
        },
        "targetGroup": null
      },
      "energyScenario": {
        "yearlyUsage": null,
        "productPreferences": {
          "campaignId": 1,
          "packageId": null,
          "moduleId": null
        }
      },
      "customer": {
        "customerId": null,
        "email": "",
        "firstName": "",
        "insertion": null,
        "lastName": "",
        "organization": "",
        "telephone": "",
        "fullName": null
      }
    }
  ]
}

Successful Response

A successful Create Design request provides an URL to the Quickr Design App, in which the created Design can be edited. This includes for example customizing the solar panel setup, roofsurfaces, the system components and the system’s pricing.

Note: A detailed data object for all information about the (edited) design can be retrieved via the Get Designs endpoint, by providing the Calculation Id of the created Design.

Example response:

{
  "models": [
    {
      "calculationInfo": {
        "calculationId": 1,
        "refId": "…",
        "creationDate": "2025-03-06T13:56:51.265Z"
      },
      "designAppUrl": "…",
      "errors": [
        "…"
      ]
    }
  ]
}