Equipment

Accessories that attach to modules, inverters, batteries, wallboxes or subconstruction.

📄️List equipment

List your equipment catalog. Filter by `name`, `manufacturerId` or `archived`; sort and page with `limit`/`offset`. Type-specific attributes are returned under `specs`. Requires `read:materials`.

📄️Create an equipment item

Add a equipment to your catalog. Include `purchasePrice` to set what you pay for it — the catalog's net and gross selling prices are derived from that and your margins. Requires `write:materials`.

📄️Update an equipment item by manufacturer article number

Same as updating by id, but the product is identified by `manufacturerArticleNumber` (plus `manufacturerId` when two manufacturers share a number) — the key a vendor price list carries, so a sync needs no id mapping of its own. Only active products are matched. Change a equipment. Every field is optional; omitted fields keep their current value. Sending `purchasePrice` records a new purchase price and points the material at it. Requires `write:materials`.

📄️Delete an equipment item by manufacturer article number

Same as deleting by id, but the product is identified by `manufacturerArticleNumber` (plus `manufacturerId` when two manufacturers share a number). Only active products are matched. Remove a equipment from your catalog. A product already used by an offer cannot be deleted — archive it instead (`archived: true`), which hides it from new offers while keeping existing ones intact. Requires `write:materials`.

📄️Get an equipment item

Fetch one equipment from your catalog. To look it up by manufacturer article number, list with `?manufacturerArticleNumber=` (and `manufacturerId`) instead. Requires `read:materials`.

📄️Update an equipment item

Change a equipment. Every field is optional; omitted fields keep their current value. Sending `purchasePrice` records a new purchase price and points the material at it. Requires `write:materials`. To address the product by manufacturer article number instead of id, use the same method on `/v1/materials/equipment?manufacturerArticleNumber=…`.

📄️Delete an equipment item

Remove a equipment from your catalog. A product already used by an offer cannot be deleted — archive it instead (`archived: true`), which hides it from new offers while keeping existing ones intact. Requires `write:materials`. To address the product by manufacturer article number instead of id, use the same method on `/v1/materials/equipment?manufacturerArticleNumber=…`.