Octibiz
Demo

Durchsucht Website und Dokumentation gemeinsam. Enter zeigt alle Treffer, Esc schließt.

Products & PIM — API and MCP

Overview

This area exposes 74 operations. Each of them is at the same time an MCP tool.

This area is behind the module switch module.products. With the module off, these operations answer 404.

Operations

MethodPathPurposePermissionParameters
GET/api/v1/price-listsCollection of PriceListproducts.pricing.manage · products.catalog.viewpage, scope, customerId, active, q, brandId
POST/api/v1/price-listsCreate a PriceListproducts.pricing.manage+ body
DELETE/api/v1/price-lists/{ulid}Delete a PriceListproducts.pricing.manageulid
GET/api/v1/price-lists/{ulid}Read one PriceListproducts.catalog.viewulid
PATCH/api/v1/price-lists/{ulid}Update a PriceListproducts.pricing.manageulid, + body
GET/api/v1/product-categoriesCollection of ProductCategoryproducts.catalog.view · products.catalog.managekind, parentId, q
POST/api/v1/product-categoriesCreate a ProductCategoryproducts.catalog.manage+ body
DELETE/api/v1/product-categories/{ulid}Delete a ProductCategoryproducts.catalog.manageulid
GET/api/v1/product-categories/{ulid}Read one ProductCategoryproducts.catalog.view · products.catalog.manageulid
PATCH/api/v1/product-categories/{ulid}Update a ProductCategoryproducts.catalog.manageulid, + body
POST/api/v1/product-categories/{ulid}/moveMove product category — Move product category. Dedicated action endpoint — not a standard CRUD create.products.catalog.manageulid, + body
POST/api/v1/product-configurations/previewKonfiguration eines Artikels prüfen (Vorschau) — Prüft eine Auswahl (selections: [{optionUlid, qty}]) gegen den Konfigurator des Artikels productId, rechnet den Aufpreis und den Einzelpreis (Grundpreis aus der Preis-Engine für customerId/brandId/qty + Aufpreise) und nennt Verstöße — ohne etwas zu speichern. Mit fxRate (am Beleg eingefrorener Kurs, Fremdwährung je 1 EUR) steht unitPriceAmount in Belegwährung. Mit cartQty (belegweite Menge desselben Artikels) greift eine Staffel mit Basis cart_total; ohne die Angabe zählt qty.products.catalog.view · products.catalog.manage+ body
GET/api/v1/product-delivery-timesCollection of ProductDeliveryTimeproducts.catalog.view · products.catalog.managepage, active
GET/api/v1/product-entitlement-rulesCollection of ProductEntitlementRuleproducts.catalog.view · products.catalog.managepage, productId, variantId, featureKey
POST/api/v1/product-entitlement-rulesCreate a ProductEntitlementRuleproducts.catalog.manage+ body
DELETE/api/v1/product-entitlement-rules/{ulid}Delete a ProductEntitlementRuleproducts.catalog.manageulid
GET/api/v1/product-entitlement-rules/{ulid}Read one ProductEntitlementRuleproducts.catalog.viewulid
PATCH/api/v1/product-entitlement-rules/{ulid}Update a ProductEntitlementRuleproducts.catalog.manageulid, + body
GET/api/v1/product-facetsKatalog-Facetten mit Trefferzahl — Facetten der Artikelliste: je filterbarer, aktiver Eigenschaftsgruppe die aktiven Optionen mit Trefferzahl, dazu je Hersteller die Trefferzahl. Nimmt dieselben Filter wie GET /v1/products. Eine Facette zählt ohne ihre eigene Auswahl, damit weitere Optionen derselben Gruppe wählbar bleiben. Nicht filterbare Eigenschaften erscheinen nicht.products.catalog.view · products.catalog.manageq, type, status, active, brandId, categoryUlid, categoryId, streamUlid, sellable, configurable, barcode, productKind, isOwnProduct, manufacturerUlid, propertyOptionUlids, locale
GET/api/v1/product-manufacturersCollection of ProductManufacturerproducts.catalog.view · products.catalog.managepage, active, q
POST/api/v1/product-manufacturersCreate a ProductManufacturerproducts.catalog.manage+ body
DELETE/api/v1/product-manufacturers/{ulid}Delete a ProductManufacturerproducts.catalog.manageulid
GET/api/v1/product-manufacturers/{ulid}Read one ProductManufacturerproducts.catalog.view · products.catalog.manageulid
PATCH/api/v1/product-manufacturers/{ulid}Update a ProductManufacturerproducts.catalog.manageulid, + body
GET/api/v1/product-property-groupsCollection of ProductPropertyGroupproducts.catalog.view · products.catalog.managepage, active, variantForming, q
POST/api/v1/product-property-groupsCreate a ProductPropertyGroupproducts.catalog.manage+ body
DELETE/api/v1/product-property-groups/{ulid}Delete a ProductPropertyGroupproducts.catalog.manageulid
GET/api/v1/product-property-groups/{ulid}Read one ProductPropertyGroupproducts.catalog.view · products.catalog.manageulid
PATCH/api/v1/product-property-groups/{ulid}Update a ProductPropertyGroupproducts.catalog.manageulid, + body
GET/api/v1/product-stockCollection of ProductStockproducts.stock.view · products.stock.managepage, belowReorder, onlyUnvalued, q
PATCH/api/v1/product-stock-take-lines/{ulid}Updates the StockTakeLine resource. — Trägt den gezählten Ist-Bestand ein. version MUSS die zuvor gelesene Version sein — sonst 409 (ein zweiter Zählender war schneller).products.stock.manageulid, + body
GET/api/v1/product-stock-takesCollection of StockTakeproducts.stock.view · products.stock.managepage, status, type, brandId
POST/api/v1/product-stock-takesCreate a StockTakeproducts.stock.manage+ body
GET/api/v1/product-stock-takes/{ulid}Read one StockTakeproducts.stock.view · products.stock.manageulid
PATCH/api/v1/product-stock-takes/{ulid}Update a StockTakeproducts.stock.manageulid, + body
POST/api/v1/product-stock-takes/{ulid}/adopt-expectedAktuelle Bestände übernehmen — Übernimmt für alle NOCH UNGEZÄHLTEN Zeilen den eingefrorenen Sollstand als Zählwert — die Aussage „hier stimmt es", und damit ohne Differenz. Das ist die zweite Hälfte der Zettelinventur: auf Papier gezählt wird nur, was auffällt, und ohne diese Übernahme müsste trotzdem jede der womöglich tausenden übrigen Zeilen einzeln bestätigt werden, weil ungezählte Zeilen das Buchen blockieren. Bereits gezählte Zeilen bleiben unberührt — eine Übernahme darf eine Feststellung nie überschreiben. Bei blinder Zählung nicht verfügbar (422).products.stock.manageulid, + body
POST/api/v1/product-stock-takes/{ulid}/bookInventurdifferenzen buchen — Bucht die Differenzen als Bewegungsart inventory. FINAL — nicht rückgängig. Scheitert, solange ungezählte Zeilen offen sind. Läuft unter Zeilensperre in EINER Transaktion und bucht genau einmal; ein Sperr-Konflikt ist 409 (erneut versuchen). Über X-Idempotency-Key benennbar: die Wiederholung desselben Vorgangs bucht nichts nach.products.stocktake.bookulid, + body
POST/api/v1/product-stock-takes/{ulid}/cancelCancel product stock take — Cancel product stock take. Dedicated action endpoint — not a standard CRUD create.products.stock.manageulid, + body
POST/api/v1/product-stock-takes/{ulid}/finishZählung abschließen — Schließt die Zählung ab (counting → counted). Differenzen sind jetzt prüfbar, gebucht ist noch nichts.products.stock.manageulid, + body
GET/api/v1/product-stock-takes/{ulid}/linesCollection of StockTakeLineproducts.stock.view · products.stock.manageulid, page, onlyDifferences, onlyUncounted, productId, warehouseId, binId
POST/api/v1/product-stock-takes/{ulid}/populateZählzeilen anlegen und Sollstand einfrieren — Legt die Zählzeilen an und friert den Sollstand je Artikel UND Ort ein. Der Zuschnitt der Inventur (scope: warehouseIds, categoryIds, binTypes, productIds, conditions) wird dabei ausgewertet: bei aktivem Mehrlager entsteht eine Zeile je (Artikel, Lager), bei gesetzten binTypes eine Zeile je belegtem Lagerplatz. Optional productIds im Rumpf grenzt zusätzlich ein (Schnittmenge mit dem Zuschnitt); ohne Mehrlager-Add-on wie bisher eine Zeile je lagergeführtem Artikel.products.stock.manageulid, + body
GET/api/v1/product-stock-takes/{ulid}/protocolRetrieves a StockTake resource. — Zählprotokoll als PDF: je Zeile Soll, Ist, Differenz, Zeitstempel und Zähler — das Beweisdokument der Inventur.products.stock.view · products.stock.manageulid
POST/api/v1/product-stock-takes/{ulid}/startZählung freigeben — Gibt die Zählung frei (draft → counting). Ab hier ist der Zuschnitt festgelegt. Scheitert mit 409, solange im Zuschnitt noch offene Picklisten laufen: der Zettel nennt dann die Menge VOR dem Griff, das Buch die danach — und die Inventur bucht anschließend eine Differenz, die es nie gab.products.stock.manageulid, + body
GET/api/v1/product-stock-valueRetrieves a ProductStockValue resource. — Bestandswert nach gleitendem Durchschnitt: Gesamtsumme, Zeilen je Artikel und Zustand und — ausdrücklich — die Zahl der Artikel ohne bekannten Einstandspreis. B-Ware (Zustand ≠ Neuware) steht als eigene Zeile zum Durchschnitt der Neuware desselben Artikels (keine automatische Abwertung); Summen in conditionOnHand/conditionValueAmount/conditionUnvaluedOnHand. Negativer Bestand wird mit 0 bewertet (kein Abzug vom Gesamtwert) und in negativeStockLines/negativeStockOnHand ausgewiesen.products.stock.view · products.stock.managecategoryId, onlyUnvalued, limit
GET/api/v1/product-stock/{productUlid}Read one ProductStockproducts.stock.view · products.stock.manageproductUlid
PATCH/api/v1/product-stock/{productUlid}Update a ProductStockproducts.stock.manageproductUlid, + body
POST/api/v1/product-stock/{productUlid}/adjustBestand korrigieren — Korrigiert den Bestand des Artikels und schreibt die Bewegung in das append-only Bestandsjournal (Herkunft manual). Ein Negativ-Bestand wird abgewiesen (409), solange er nicht ausdrücklich erlaubt ist.products.stock.manageproductUlid, + body
GET/api/v1/product-stream-fieldsCollection of ProductStreamFieldproducts.catalog.view · products.catalog.manage—
GET/api/v1/product-streamsCollection of ProductStreamproducts.catalog.view · products.catalog.managepage, q
POST/api/v1/product-streamsCreate a ProductStreamproducts.catalog.manage+ body
DELETE/api/v1/product-streams/{ulid}Delete a ProductStreamproducts.catalog.manageulid
GET/api/v1/product-streams/{ulid}Read one ProductStreamproducts.catalog.viewulid
PATCH/api/v1/product-streams/{ulid}Update a ProductStreamproducts.catalog.manageulid, + body
GET/api/v1/product-variantsCollection of ProductVariantproducts.catalog.view · products.catalog.managepage, productId
POST/api/v1/product-variantsCreate a ProductVariantproducts.catalog.manage+ body
DELETE/api/v1/product-variants/{ulid}Delete a ProductVariantproducts.catalog.manageulid
GET/api/v1/product-variants/{ulid}Read one ProductVariantproducts.catalog.view · products.catalog.manageulid
PATCH/api/v1/product-variants/{ulid}Update a ProductVariantproducts.catalog.manageulid, + body
GET/api/v1/product-versionsCollection of ProductVersionproducts.catalog.view · products.catalog.managepage, productId
POST/api/v1/product-versionsCreate a ProductVersionproducts.catalog.manage+ body
DELETE/api/v1/product-versions/{ulid}Delete a ProductVersionproducts.catalog.manageulid
GET/api/v1/product-versions/{ulid}Read one ProductVersionproducts.catalog.view · products.catalog.manageulid
PATCH/api/v1/product-versions/{ulid}Update a ProductVersionproducts.catalog.manageulid, + body
GET/api/v1/productsCollection of Productproducts.catalog.view · products.catalog.managepage, type, status, brandId, categoryId, categoryUlid, isOwnProduct, active, productKind, sellable, configurable, streamUlid, q, barcode, manufacturerUlid, propertyOptionUlids, order[name], order[defaultPriceAmount], customerId
POST/api/v1/productsCreate a Productproducts.catalog.manage+ body
POST/api/v1/products/bulkCreate a ProductBulkActionproducts.catalog.manage+ body
POST/api/v1/products/duplicateCreate a ProductDuplicateproducts.catalog.manage+ body
POST/api/v1/products/importCreate a ProductImportproducts.catalog.manage+ body
DELETE/api/v1/products/{ulid}Delete a Productproducts.catalog.manageulid
GET/api/v1/products/{ulid}Read one Productproducts.catalog.view · products.catalog.manageulid
PATCH/api/v1/products/{ulid}Update a Productproducts.catalog.manageulid, + body
POST/api/v1/products/{ulid}/generate-variantsVarianten aus den Achsen erzeugen — Spannt aus den Achsen des Variantensets das kartesische Produkt der aktiven Optionen auf und legt fehlende Varianten idempotent an. Ein Rumpf ist nicht nötig.products.catalog.manageulid, + body
GET/api/v1/stock-condition-changesCollection of StockConditionChangeproducts.stock.view · products.stock.manage · products.stock.change_conditionproductId, warehouseId
POST/api/v1/stock-condition-changesArtikelzustand umbuchen — Bucht qty Stück eines Artikels vom Zustand fromCondition in den Zustand toCondition (new, refurbished, used, damaged) — z. B. geprüfte B-Ware wird Neuware. Eigene Bewegungsart im Bestandsjournal, Bewertung unverändert. Nur freier Bestand des Quellzustands ist umbuchbar (sonst 409). Bei Mehrlager optional warehouseId/binId (Abgang und Zugang am selben Platz).products.stock.change_condition+ body

Purpose texts that do not follow the standard pattern are taken verbatim from the interface description in the code.

referenz.api-products · Available from version 0.5.4