AUautarc
Products

Update a product

Partial update of a product's commercial fields and prices. You only need to provide the fields you want to update.

patch/products/{productId}

Request

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

Path parameters

productIdstring uuid required

Request body

namestring
descriptionstring nullable

Send an empty string to clear.

typestring

The product type (enum value).

unitstring

The unit the product is sold in (enum value).

status'draft' | 'active' | 'archived'
manufacturerstring nullable

Send an empty string to clear.

articleNumberstring nullable

Send an empty string to clear.

priceInCentnumber

Net unit price in cents.

taxRatenumber

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

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.