Octibiz
Demo

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

Verkaufskanäle — API und MCP

Überblick

Dieser Bereich stellt 23 Operationen bereit. Jede davon ist zugleich ein MCP-Werkzeug.

Der Bereich hängt am Modul-Schalter module.channels. Ist das Modul aus, antworten diese Operationen mit 404.

Operationen

MethodePfadZweckRechtParameter
GET/api/v1/channels/channelsListe der SalesChannelchannels.channel.view · channels.channel.managepage, active, connectorType, channelKey, q
POST/api/v1/channels/channelsCreates a SalesChannel resource. — Legt einen Kanal an. Er entsteht INAKTIV — ein Kanal, der mit dem ersten POST scharf ist, geht in dem Moment gegen ein Fremdsystem, in dem jemand ihn halb fertig speichert.channels.channel.manage+ Rumpf
DELETE/api/v1/channels/channels/{ulid}Eine SalesChannel löschenchannels.channel.manageulid
GET/api/v1/channels/channels/{ulid}Eine SalesChannel lesenchannels.channel.view · channels.channel.manageulid
PATCH/api/v1/channels/channels/{ulid}Eine SalesChannel ändernchannels.channel.manageulid, + Rumpf
POST/api/v1/channels/channels/{ulid}/activateActivate channel — Activate channel. Dedicated action endpoint — not a standard CRUD create.channels.channel.manageulid, + Rumpf
POST/api/v1/channels/channels/{ulid}/checkoutsWarenkörbe des Kanals übernehmen — Übernimmt begonnene Warenkörbe (Checkouts) dieses Kanals (checkouts = einer oder eine Liste, höchstens 100) — der Weg für Shop-Webhooks wie Shopify checkouts/create und checkouts/update und eigene Zuordnungen über einen Connect-Flow (06:ENT-OWNER-RUNDE-1021-45). Felder je Warenkorb: externalId (Pflicht, Wiedererkennung je Kanal), email, phone, firstName, lastName, locale, currency, totalAmount (Cent), items ([{sku, title, qty, unitPriceAmount}] oder in Shop-Form quantity + price als Dezimalzahl), recoveryUrl, startedAt, updatedAt, completedAt (gesetzt = bestellt). Jede Meldung schreibt denselben Warenkorb fort. Ruht er eine Stunde mit Adresse und ohne Bestellung, meldet die Standard-Automation „Warenkorb verlassen". Antwort result: imported, updated, ordered, invalid.channels.sync.executeulid, + Rumpf
POST/api/v1/channels/channels/{ulid}/deactivateDeactivate channel — Deactivate channel. Dedicated action endpoint — not a standard CRUD create.channels.channel.manageulid, + Rumpf
POST/api/v1/channels/channels/{ulid}/fulfillmentSendung an den Kanal zurückmelden — Meldet eine Sendung samt Sendungsnummer an den Kanal zurück (Befund R47-015). Ziel ist entweder externalOrderId (Fremd-Kennung) oder orderUlid (eigener Auftrag); dazu carrier, trackingNumber, trackingUrl, shippedAt und optional lines für eine Teilsendung. Positions-Kennungen legt der Rahmen aus dem Bestell-Import bei — Marktplätze melden je POSITION. Ohne diese Meldung sieht der Käufer seine Bestellung nie als versandt und der Marktplatz zählt sie als verspätet. Der geplante Betrieb ruft GENAU DIESE Operation über den Baustein <gruppe>_fulfillment_push auf.channels.sync.executeulid, + Rumpf
POST/api/v1/channels/channels/{ulid}/ordersKanal-Bestellungen als Aufträge übernehmen — Übernimmt bereits zugeordnete Bestellungen dieses Kanals als Aufträge (orders = eine Bestellung oder eine Liste). Der Weg für Shop-Webhooks und eigene Zuordnungen: ein Connect-Flow ordnet die Felder des Fremdsystems zu und ruft diese Operation über octibiz_api auf. Idempotent über (Kanal, Fremd-Kennung) — eine doppelt gemeldete Bestellung wird übersprungen, nicht doppelt angelegt.channels.sync.executeulid, + Rumpf
POST/api/v1/channels/channels/{ulid}/syncSync channel — Sync channel. Dedicated action endpoint — not a standard CRUD create.channels.sync.executeulid, + Rumpf
POST/api/v1/channels/channels/{ulid}/test-connectionKanal-Verbindung prüfen — Prüft die Verbindung, ohne etwas zu verändern. Antwort: valid + errors.channels.channel.manageulid, + Rumpf
GET/api/v1/channels/checkoutsWarenkörbe der Kanäle — Begonnene Warenkörbe mit Adresse, Summe (Cent), Positionen, letzter Aktivität und Stand: offen, verlassen gemeldet (Auslöser der Warenkorb-Erinnerung) oder doch bestellt. Neueste Aktivität zuerst.channels.checkout.viewpage, status, channelUlid, q
GET/api/v1/channels/checkouts/{ulid}Eine ChannelCheckout lesenchannels.checkout.viewulid
GET/api/v1/channels/connector-typesRetrieves the collection of ChannelConnectorType resources. — Alle verfügbaren Kanal-Konnektoren mit Fähigkeiten und Konfigurationsfeldern. Konnektoren deaktivierter Plugins fehlen hier.channels.channel.view · channels.channel.manage—
GET/api/v1/channels/external-stockFremdbestand eines Kanals (FBA) ansehenchannels.channel.view · channels.channel.managepage, channelUlid, sku, q, inStock
GET/api/v1/channels/listingsRetrieves the collection of ChannelListing resources. — Angebote je Kanal mit Status, letztem Abgleich und letztem Fehler. Mit productId und includeVariants=1 der Shop-Sync-Stand eines Artikels samt seiner Varianten (Reiter am Artikel).channels.channel.view · channels.listing.managepage, channelUlid, status, productId, includeVariants
POST/api/v1/channels/listingsCreates a ChannelListing resource. — Stellt einen Artikel in einen Kanal. overrides trägt NUR, was im Kanal anders ist — alles Ungesetzte kommt aus dem Artikel. Ein Artikel steht je Kanal genau einmal.channels.listing.manage+ Rumpf
DELETE/api/v1/channels/listings/{ulid}Eine ChannelListing löschenchannels.listing.manageulid
GET/api/v1/channels/listings/{ulid}Eine ChannelListing lesenchannels.channel.view · channels.listing.manageulid
PATCH/api/v1/channels/listings/{ulid}Eine ChannelListing ändernchannels.listing.manageulid, + Rumpf
POST/api/v1/channels/listings/{ulid}/republishAngebot wieder in die Kanal-Läufe aufnehmen — Nimmt das Angebot wieder in die Läufe auf (Zustand draft) und verwirft den Fingerabdruck, damit der nächste Lauf es sicher sendet.channels.listing.manageulid, + Rumpf
POST/api/v1/channels/listings/{ulid}/unpublishAngebot im Kanal zurückziehen — Zieht das Angebot zurück: es wird von künftigen Läufen übersprungen. Der Eintrag bleibt stehen — ihn zu löschen nähme die Kennung im Fremdsystem mit, an der eingehende Bestellungen hängen.channels.listing.manageulid, + Rumpf

Zweckangaben, die nicht dem Standardmuster folgen, stammen unverändert aus der Schnittstellen-Beschreibung im Code.

referenz.api-channels · Gilt ab Version 0.5.4