Produkt anlegen
Legt ein einzelnes Produkt an einem Standort an.
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"
}
'import requests
url = "https://api.blueplant.app/api/v1/product/product"
payload = {
"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"
}
headers = {
"ApiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {ApiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.blueplant.app/api/v1/product/product', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blueplant.app/api/v1/product/product",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blueplant.app/api/v1/product/product"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerSizeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"externalId\": \"<string>\",\n \"externalOrderNumber\": \"<string>\",\n \"initialPrice\": 1,\n \"isInheritedProduct\": false,\n \"locationDetails\": {\n \"building\": \"<string>\",\n \"floor\": 123,\n \"room\": \"<string>\",\n \"detail\": \"<string>\",\n \"note\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"placementDate\": \"2023-12-25\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blueplant.app/api/v1/product/product")
.header("ApiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerSizeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"externalId\": \"<string>\",\n \"externalOrderNumber\": \"<string>\",\n \"initialPrice\": 1,\n \"isInheritedProduct\": false,\n \"locationDetails\": {\n \"building\": \"<string>\",\n \"floor\": 123,\n \"room\": \"<string>\",\n \"detail\": \"<string>\",\n \"note\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"placementDate\": \"2023-12-25\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blueplant.app/api/v1/product/product")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerSizeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"externalId\": \"<string>\",\n \"externalOrderNumber\": \"<string>\",\n \"initialPrice\": 1,\n \"isInheritedProduct\": false,\n \"locationDetails\": {\n \"building\": \"<string>\",\n \"floor\": 123,\n \"room\": \"<string>\",\n \"detail\": \"<string>\",\n \"note\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"placementDate\": \"2023-12-25\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "invalid input",
"errors": [
{}
]
}Authorizations
Dein API-Schlüssel aus den Mandanten-Einstellungen, gesendet im Header ApiKey.
Body
application/json
Bezeichnung des Produkts.
Maximum string length:
64ID des Kunden.
ID der Pflanzenart.
ID des Standorts.
ID des Pflanzenbehälters.
ID der Behältergröße.
Eigene Referenz aus deinem System.
Maximum string length:
128Bestellnummer aus deinem System.
Maximum string length:
128Anschaffungspreis.
Required range:
x >= 0Ob das Produkt von einem anderen geerbt wurde.
Genauer Standort des Produkts innerhalb des Gebäudes.
Show child attributes
Show child attributes
Freie Notizen zum Produkt.
Maximum string length:
512Datum der Aufstellung.
Beginn der Gültigkeit.
Ende der Gültigkeit.
Response
Produkt angelegt.
Antwort mit der ID des angelegten Objekts.
ID des angelegten Objekts.
⌘I
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"
}
'import requests
url = "https://api.blueplant.app/api/v1/product/product"
payload = {
"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"
}
headers = {
"ApiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {ApiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.blueplant.app/api/v1/product/product', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blueplant.app/api/v1/product/product",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blueplant.app/api/v1/product/product"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerSizeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"externalId\": \"<string>\",\n \"externalOrderNumber\": \"<string>\",\n \"initialPrice\": 1,\n \"isInheritedProduct\": false,\n \"locationDetails\": {\n \"building\": \"<string>\",\n \"floor\": 123,\n \"room\": \"<string>\",\n \"detail\": \"<string>\",\n \"note\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"placementDate\": \"2023-12-25\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blueplant.app/api/v1/product/product")
.header("ApiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerSizeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"externalId\": \"<string>\",\n \"externalOrderNumber\": \"<string>\",\n \"initialPrice\": 1,\n \"isInheritedProduct\": false,\n \"locationDetails\": {\n \"building\": \"<string>\",\n \"floor\": 123,\n \"room\": \"<string>\",\n \"detail\": \"<string>\",\n \"note\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"placementDate\": \"2023-12-25\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blueplant.app/api/v1/product/product")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"siteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerSizeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"externalId\": \"<string>\",\n \"externalOrderNumber\": \"<string>\",\n \"initialPrice\": 1,\n \"isInheritedProduct\": false,\n \"locationDetails\": {\n \"building\": \"<string>\",\n \"floor\": 123,\n \"room\": \"<string>\",\n \"detail\": \"<string>\",\n \"note\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"placementDate\": \"2023-12-25\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "invalid input",
"errors": [
{}
]
}