AUautarc
Products

Get product by id

get/products/{productId}

Request

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

Path parameters

productIdstring uuid required

ID of the product to fetch

Response

A single product

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.