Create or upsert a product
curl --request POST \
--url https://{tenant}.app.big-panda.ai/api/knowledge/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"language": "<string>",
"external_id": "<string>",
"description": "<string>",
"short_description": "<string>",
"sku": "<string>",
"gtin": "<string>",
"brand": "<string>",
"category": "<string>",
"attributes": {},
"properties": {},
"price_current": 123,
"price_msrp": 123,
"price_special": 123,
"price_on_request": false,
"currency": "EUR",
"image_url": "<string>",
"additional_images": [
"<string>"
],
"product_url": "<string>",
"availability": "<string>",
"rating_average": 2.5,
"rating_count": 0,
"parent_external_id": "<string>",
"is_variant": false,
"is_parent": false,
"similarity_text": "<string>",
"search_keywords": [
"<string>"
],
"embedding_text_description": "<string>",
"embedding_text_properties": "<string>",
"embedding_text_attributes": "<string>",
"sync_hash": "<string>"
}
'import requests
url = "https://{tenant}.app.big-panda.ai/api/knowledge/products"
payload = {
"title": "<string>",
"language": "<string>",
"external_id": "<string>",
"description": "<string>",
"short_description": "<string>",
"sku": "<string>",
"gtin": "<string>",
"brand": "<string>",
"category": "<string>",
"attributes": {},
"properties": {},
"price_current": 123,
"price_msrp": 123,
"price_special": 123,
"price_on_request": False,
"currency": "EUR",
"image_url": "<string>",
"additional_images": ["<string>"],
"product_url": "<string>",
"availability": "<string>",
"rating_average": 2.5,
"rating_count": 0,
"parent_external_id": "<string>",
"is_variant": False,
"is_parent": False,
"similarity_text": "<string>",
"search_keywords": ["<string>"],
"embedding_text_description": "<string>",
"embedding_text_properties": "<string>",
"embedding_text_attributes": "<string>",
"sync_hash": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
language: '<string>',
external_id: '<string>',
description: '<string>',
short_description: '<string>',
sku: '<string>',
gtin: '<string>',
brand: '<string>',
category: '<string>',
attributes: {},
properties: {},
price_current: 123,
price_msrp: 123,
price_special: 123,
price_on_request: false,
currency: 'EUR',
image_url: '<string>',
additional_images: ['<string>'],
product_url: '<string>',
availability: '<string>',
rating_average: 2.5,
rating_count: 0,
parent_external_id: '<string>',
is_variant: false,
is_parent: false,
similarity_text: '<string>',
search_keywords: ['<string>'],
embedding_text_description: '<string>',
embedding_text_properties: '<string>',
embedding_text_attributes: '<string>',
sync_hash: '<string>'
})
};
fetch('https://{tenant}.app.big-panda.ai/api/knowledge/products', 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://{tenant}.app.big-panda.ai/api/knowledge/products",
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([
'title' => '<string>',
'language' => '<string>',
'external_id' => '<string>',
'description' => '<string>',
'short_description' => '<string>',
'sku' => '<string>',
'gtin' => '<string>',
'brand' => '<string>',
'category' => '<string>',
'attributes' => [
],
'properties' => [
],
'price_current' => 123,
'price_msrp' => 123,
'price_special' => 123,
'price_on_request' => false,
'currency' => 'EUR',
'image_url' => '<string>',
'additional_images' => [
'<string>'
],
'product_url' => '<string>',
'availability' => '<string>',
'rating_average' => 2.5,
'rating_count' => 0,
'parent_external_id' => '<string>',
'is_variant' => false,
'is_parent' => false,
'similarity_text' => '<string>',
'search_keywords' => [
'<string>'
],
'embedding_text_description' => '<string>',
'embedding_text_properties' => '<string>',
'embedding_text_attributes' => '<string>',
'sync_hash' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{tenant}.app.big-panda.ai/api/knowledge/products"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"language\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"sku\": \"<string>\",\n \"gtin\": \"<string>\",\n \"brand\": \"<string>\",\n \"category\": \"<string>\",\n \"attributes\": {},\n \"properties\": {},\n \"price_current\": 123,\n \"price_msrp\": 123,\n \"price_special\": 123,\n \"price_on_request\": false,\n \"currency\": \"EUR\",\n \"image_url\": \"<string>\",\n \"additional_images\": [\n \"<string>\"\n ],\n \"product_url\": \"<string>\",\n \"availability\": \"<string>\",\n \"rating_average\": 2.5,\n \"rating_count\": 0,\n \"parent_external_id\": \"<string>\",\n \"is_variant\": false,\n \"is_parent\": false,\n \"similarity_text\": \"<string>\",\n \"search_keywords\": [\n \"<string>\"\n ],\n \"embedding_text_description\": \"<string>\",\n \"embedding_text_properties\": \"<string>\",\n \"embedding_text_attributes\": \"<string>\",\n \"sync_hash\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.app.big-panda.ai/api/knowledge/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"language\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"sku\": \"<string>\",\n \"gtin\": \"<string>\",\n \"brand\": \"<string>\",\n \"category\": \"<string>\",\n \"attributes\": {},\n \"properties\": {},\n \"price_current\": 123,\n \"price_msrp\": 123,\n \"price_special\": 123,\n \"price_on_request\": false,\n \"currency\": \"EUR\",\n \"image_url\": \"<string>\",\n \"additional_images\": [\n \"<string>\"\n ],\n \"product_url\": \"<string>\",\n \"availability\": \"<string>\",\n \"rating_average\": 2.5,\n \"rating_count\": 0,\n \"parent_external_id\": \"<string>\",\n \"is_variant\": false,\n \"is_parent\": false,\n \"similarity_text\": \"<string>\",\n \"search_keywords\": [\n \"<string>\"\n ],\n \"embedding_text_description\": \"<string>\",\n \"embedding_text_properties\": \"<string>\",\n \"embedding_text_attributes\": \"<string>\",\n \"sync_hash\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.app.big-panda.ai/api/knowledge/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"language\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"sku\": \"<string>\",\n \"gtin\": \"<string>\",\n \"brand\": \"<string>\",\n \"category\": \"<string>\",\n \"attributes\": {},\n \"properties\": {},\n \"price_current\": 123,\n \"price_msrp\": 123,\n \"price_special\": 123,\n \"price_on_request\": false,\n \"currency\": \"EUR\",\n \"image_url\": \"<string>\",\n \"additional_images\": [\n \"<string>\"\n ],\n \"product_url\": \"<string>\",\n \"availability\": \"<string>\",\n \"rating_average\": 2.5,\n \"rating_count\": 0,\n \"parent_external_id\": \"<string>\",\n \"is_variant\": false,\n \"is_parent\": false,\n \"similarity_text\": \"<string>\",\n \"search_keywords\": [\n \"<string>\"\n ],\n \"embedding_text_description\": \"<string>\",\n \"embedding_text_properties\": \"<string>\",\n \"embedding_text_attributes\": \"<string>\",\n \"sync_hash\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tenant_id": "<string>",
"site_id": "<string>",
"external_id": "<string>",
"title": "<string>",
"description": "<string>",
"short_description": "<string>",
"sku": "<string>",
"gtin": "<string>",
"brand": "<string>",
"category": "<string>",
"attributes": {},
"properties": {},
"price_current": "<string>",
"price_msrp": "<string>",
"price_special": "<string>",
"price_on_request": true,
"currency": "<string>",
"image_url": "<string>",
"additional_images": [
"<unknown>"
],
"product_url": "<string>",
"availability": "<string>",
"rating_average": "<string>",
"rating_count": 123,
"language": "<string>",
"translation_group_id": "<string>",
"parent_product_id": "<string>",
"is_variant": true,
"is_parent": true,
"source": "<string>",
"sync_hash": "<string>",
"last_synced_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"search_keywords": [
"<string>"
],
"has_similarity_anchor": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Products
Create or upsert a product
Create a new product or update an existing one (upsert).
If external_id is provided and already exists for this site, the product is updated. Otherwise a new product is created.
The sync_hash field enables delta updates: if the hash matches the existing product’s hash, re-embedding is skipped (only metadata like price/availability is updated).
POST
/
api
/
knowledge
/
products
Create or upsert a product
curl --request POST \
--url https://{tenant}.app.big-panda.ai/api/knowledge/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"language": "<string>",
"external_id": "<string>",
"description": "<string>",
"short_description": "<string>",
"sku": "<string>",
"gtin": "<string>",
"brand": "<string>",
"category": "<string>",
"attributes": {},
"properties": {},
"price_current": 123,
"price_msrp": 123,
"price_special": 123,
"price_on_request": false,
"currency": "EUR",
"image_url": "<string>",
"additional_images": [
"<string>"
],
"product_url": "<string>",
"availability": "<string>",
"rating_average": 2.5,
"rating_count": 0,
"parent_external_id": "<string>",
"is_variant": false,
"is_parent": false,
"similarity_text": "<string>",
"search_keywords": [
"<string>"
],
"embedding_text_description": "<string>",
"embedding_text_properties": "<string>",
"embedding_text_attributes": "<string>",
"sync_hash": "<string>"
}
'import requests
url = "https://{tenant}.app.big-panda.ai/api/knowledge/products"
payload = {
"title": "<string>",
"language": "<string>",
"external_id": "<string>",
"description": "<string>",
"short_description": "<string>",
"sku": "<string>",
"gtin": "<string>",
"brand": "<string>",
"category": "<string>",
"attributes": {},
"properties": {},
"price_current": 123,
"price_msrp": 123,
"price_special": 123,
"price_on_request": False,
"currency": "EUR",
"image_url": "<string>",
"additional_images": ["<string>"],
"product_url": "<string>",
"availability": "<string>",
"rating_average": 2.5,
"rating_count": 0,
"parent_external_id": "<string>",
"is_variant": False,
"is_parent": False,
"similarity_text": "<string>",
"search_keywords": ["<string>"],
"embedding_text_description": "<string>",
"embedding_text_properties": "<string>",
"embedding_text_attributes": "<string>",
"sync_hash": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
language: '<string>',
external_id: '<string>',
description: '<string>',
short_description: '<string>',
sku: '<string>',
gtin: '<string>',
brand: '<string>',
category: '<string>',
attributes: {},
properties: {},
price_current: 123,
price_msrp: 123,
price_special: 123,
price_on_request: false,
currency: 'EUR',
image_url: '<string>',
additional_images: ['<string>'],
product_url: '<string>',
availability: '<string>',
rating_average: 2.5,
rating_count: 0,
parent_external_id: '<string>',
is_variant: false,
is_parent: false,
similarity_text: '<string>',
search_keywords: ['<string>'],
embedding_text_description: '<string>',
embedding_text_properties: '<string>',
embedding_text_attributes: '<string>',
sync_hash: '<string>'
})
};
fetch('https://{tenant}.app.big-panda.ai/api/knowledge/products', 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://{tenant}.app.big-panda.ai/api/knowledge/products",
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([
'title' => '<string>',
'language' => '<string>',
'external_id' => '<string>',
'description' => '<string>',
'short_description' => '<string>',
'sku' => '<string>',
'gtin' => '<string>',
'brand' => '<string>',
'category' => '<string>',
'attributes' => [
],
'properties' => [
],
'price_current' => 123,
'price_msrp' => 123,
'price_special' => 123,
'price_on_request' => false,
'currency' => 'EUR',
'image_url' => '<string>',
'additional_images' => [
'<string>'
],
'product_url' => '<string>',
'availability' => '<string>',
'rating_average' => 2.5,
'rating_count' => 0,
'parent_external_id' => '<string>',
'is_variant' => false,
'is_parent' => false,
'similarity_text' => '<string>',
'search_keywords' => [
'<string>'
],
'embedding_text_description' => '<string>',
'embedding_text_properties' => '<string>',
'embedding_text_attributes' => '<string>',
'sync_hash' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{tenant}.app.big-panda.ai/api/knowledge/products"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"language\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"sku\": \"<string>\",\n \"gtin\": \"<string>\",\n \"brand\": \"<string>\",\n \"category\": \"<string>\",\n \"attributes\": {},\n \"properties\": {},\n \"price_current\": 123,\n \"price_msrp\": 123,\n \"price_special\": 123,\n \"price_on_request\": false,\n \"currency\": \"EUR\",\n \"image_url\": \"<string>\",\n \"additional_images\": [\n \"<string>\"\n ],\n \"product_url\": \"<string>\",\n \"availability\": \"<string>\",\n \"rating_average\": 2.5,\n \"rating_count\": 0,\n \"parent_external_id\": \"<string>\",\n \"is_variant\": false,\n \"is_parent\": false,\n \"similarity_text\": \"<string>\",\n \"search_keywords\": [\n \"<string>\"\n ],\n \"embedding_text_description\": \"<string>\",\n \"embedding_text_properties\": \"<string>\",\n \"embedding_text_attributes\": \"<string>\",\n \"sync_hash\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.app.big-panda.ai/api/knowledge/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"language\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"sku\": \"<string>\",\n \"gtin\": \"<string>\",\n \"brand\": \"<string>\",\n \"category\": \"<string>\",\n \"attributes\": {},\n \"properties\": {},\n \"price_current\": 123,\n \"price_msrp\": 123,\n \"price_special\": 123,\n \"price_on_request\": false,\n \"currency\": \"EUR\",\n \"image_url\": \"<string>\",\n \"additional_images\": [\n \"<string>\"\n ],\n \"product_url\": \"<string>\",\n \"availability\": \"<string>\",\n \"rating_average\": 2.5,\n \"rating_count\": 0,\n \"parent_external_id\": \"<string>\",\n \"is_variant\": false,\n \"is_parent\": false,\n \"similarity_text\": \"<string>\",\n \"search_keywords\": [\n \"<string>\"\n ],\n \"embedding_text_description\": \"<string>\",\n \"embedding_text_properties\": \"<string>\",\n \"embedding_text_attributes\": \"<string>\",\n \"sync_hash\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.app.big-panda.ai/api/knowledge/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"language\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"sku\": \"<string>\",\n \"gtin\": \"<string>\",\n \"brand\": \"<string>\",\n \"category\": \"<string>\",\n \"attributes\": {},\n \"properties\": {},\n \"price_current\": 123,\n \"price_msrp\": 123,\n \"price_special\": 123,\n \"price_on_request\": false,\n \"currency\": \"EUR\",\n \"image_url\": \"<string>\",\n \"additional_images\": [\n \"<string>\"\n ],\n \"product_url\": \"<string>\",\n \"availability\": \"<string>\",\n \"rating_average\": 2.5,\n \"rating_count\": 0,\n \"parent_external_id\": \"<string>\",\n \"is_variant\": false,\n \"is_parent\": false,\n \"similarity_text\": \"<string>\",\n \"search_keywords\": [\n \"<string>\"\n ],\n \"embedding_text_description\": \"<string>\",\n \"embedding_text_properties\": \"<string>\",\n \"embedding_text_attributes\": \"<string>\",\n \"sync_hash\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"tenant_id": "<string>",
"site_id": "<string>",
"external_id": "<string>",
"title": "<string>",
"description": "<string>",
"short_description": "<string>",
"sku": "<string>",
"gtin": "<string>",
"brand": "<string>",
"category": "<string>",
"attributes": {},
"properties": {},
"price_current": "<string>",
"price_msrp": "<string>",
"price_special": "<string>",
"price_on_request": true,
"currency": "<string>",
"image_url": "<string>",
"additional_images": [
"<unknown>"
],
"product_url": "<string>",
"availability": "<string>",
"rating_average": "<string>",
"rating_count": 123,
"language": "<string>",
"translation_group_id": "<string>",
"parent_product_id": "<string>",
"is_variant": true,
"is_parent": true,
"source": "<string>",
"sync_hash": "<string>",
"last_synced_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"search_keywords": [
"<string>"
],
"has_similarity_anchor": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API-Token aus dem Big-Panda-Admin-UI unter Einstellungen → API-Keys. Header: Authorization: Bearer <token>.
Query Parameters
Site to push the product to (UUID or slug)
Body
application/json
Payload for creating/upserting a product.
If external_id is provided and already exists for this site, the product is updated (upsert). Otherwise a new product is created.
Embedding texts are optional — if provided, they are used directly for embedding generation. If omitted, the system generates them from title + description/properties/attributes.
Minimum string length:
1Required string length:
2 - 5Maximum string length:
200Maximum string length:
100GTIN/EAN barcode
Maximum string length:
50Maximum string length:
200Maximum string length:
3Maximum string length:
50Required range:
0 <= x <= 5Required range:
x >= 0external_id of the parent product (for variants)
True for concrete variants (children of a parent).
True for abstract parent/master products that have variant children. Excluded from search when the tenant runs with variant_strategy=children_only.
Anchor text for the centroid_similar.py 'find related' path. Connector typically composes this from a small, stable set of attributes (e.g. perfume: 'Duft + Saison').
Alternative spellings / synonyms / JTL-Suchbegriffe. Boosts BM25-matches without affecting semantic search.
Pre-assembled text for description embedding. If omitted, generated from title + description.
Pre-assembled text for properties embedding. If omitted, generated from title + properties.
Pre-assembled text for attributes embedding. If omitted, generated from title + attributes.
Hash of the source data. If unchanged from last sync, skip re-embedding.
Maximum string length:
64Response
Successful Response
Product data returned in API responses.
Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Pattern:
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$