Skip to main content
POST
/
product
/
product
Produkt anlegen
curl --request POST \
  --url https://api.blueplant.app/api/v1/product/product \
  --header 'ApiKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "containerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "containerSizeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "externalOrderNumber": "<string>",
  "initialPrice": 1,
  "isInheritedProduct": false,
  "locationDetails": {
    "building": "<string>",
    "floor": 123,
    "room": "<string>",
    "detail": "<string>",
    "note": "<string>"
  },
  "notes": "<string>",
  "placementDate": "2023-12-25",
  "validFrom": "2023-12-25",
  "validUntil": "2023-12-25"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
ApiKey
string
header
required

Dein API-Schlüssel aus den Mandanten-Einstellungen, gesendet im Header ApiKey.

Body

application/json
​
name
string
required

Bezeichnung des Produkts.

Maximum string length: 64
​
customerId
string<uuid>
required

ID des Kunden.

​
plantId
string<uuid>
required

ID der Pflanzenart.

​
siteId
string<uuid>
required

ID des Standorts.

​
containerId
string<uuid>

ID des Pflanzenbehälters.

​
containerSizeId
string<uuid>

ID der Behältergröße.

​
externalId
string

Eigene Referenz aus deinem System.

Maximum string length: 128
​
externalOrderNumber
string

Bestellnummer aus deinem System.

Maximum string length: 128
​
initialPrice
number

Anschaffungspreis.

Required range: x >= 0
​
isInheritedProduct
boolean
default:false

Ob das Produkt von einem anderen geerbt wurde.

​
locationDetails
object

Genauer Standort des Produkts innerhalb des Gebäudes.

​
notes
string

Freie Notizen zum Produkt.

Maximum string length: 512
​
placementDate
string<date>

Datum der Aufstellung.

​
validFrom
string<date>

Beginn der Gültigkeit.

​
validUntil
string<date>

Ende der Gültigkeit.

Response

Produkt angelegt.

Antwort mit der ID des angelegten Objekts.

​
id
string<uuid>

ID des angelegten Objekts.