Products

Get products

Returns the company's product catalog (with prices), ordered by last update (newest first). Archived products are excluded unless includeArchived=true.

get/products

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Query parameters

typestring

Filter by product type (enum value, e.g. heatPump).

includeArchivedboolean

Include archived products in the result.

limitinteger

Maximum number of products to return. Defaults to 50 and caps at 200.

Response

A list of products

idstring uuid required
typestring required

The product type.

namestring required

The product name.

descriptionstring nullable

Free-text description.

manufacturerstring nullable

The manufacturer / brand.

articleNumberstring nullable

The manufacturer's article number.

unitstring required

The unit the product is sold in.

priceInCentnumber nullable

Net unit price in cents (e.g. 199900 = €1,999.00).

taxRatenumber nullable

VAT rate as a percentage (e.g. 19 for 19%).

status'draft' | 'active' | 'archived' required

The product status.

createdAtstring date-time required
updatedAtstring date-time required
nominalPowernumber nullable

Solar module STC nominal power (Pmax), in watts. Only present when type is solarPanel; omitted when not recorded.

totalEnergynumber nullable

Battery nominal / total energy capacity, in kWh. This is the nominal capacity, not the usable capacity, and not an amp-hour rating. Only present when type is battery; omitted when not recorded.

Example response

[
  {
    "type": "heatPump",
    "unit": "piece",
    "nominalPower": 410,
    "totalEnergy": 10.24
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.