Get Packages

An easy guide to get all Packages information available within an existing campaign.

Get Packages Endpoint

To successfully obtain available Packages information within a campaign, the following endpoint can be used:

Endpoint:
https://api.novasole.com/packages

Request Method:
GET

Request Body

This endpoint requires a valid bearer token and Campaign Id provided as a query parameter. To get a valid Campaign Id, use the Get Campaign endpoint. To obtain a valid bearer token, please refer to the Authentication page for more information.

Successful Response

A successful request provides a list of all available Packages within a campaign.

[
  {
    "id": 1,
    "name": "string",
    "sortIndex": 1
  }
]

Using the Package Id’s

The Package Id’s can be used in the request body for the Create Scan or Create Design endpoints. A package contains certain product preferences on defaults for creating an energy system. This information will be automatically retrieved in the Create Scan or Design endpoint when passing a certain Package Id in the request body of that endpoint.