Angebote per API bzw. Schnittstelle erstellen

Um große Mengen unterschiedlicher Angebote gleichzeitig auf den digitalen Marktplatz zu bringen, bietet sich außerdem die Möglichkeit, den Prozess der Angebotserstellung per Schnittstelle zu automatisieren.

Einen Überblick über weitere Möglichkeiten der Angebotserstellung finden Sie hier: Übersicht: Die unterschiedlichen Methoden der Angebotserstellung

Der Weg über eine Schnittstelle eignet sich besonders für Anbietende, die ein breites Angebotsspektrum und einen großen Produktkatalog haben.

Hier finden Sie alle Informationen zu Voraussetzungen und Anwendungsmöglichkeiten.



Voraussetzungen I – Technische Settings​


  • Link zur Marktplatz-Plattform ist bekannt
  • Link zur Mirakl-Help-Seite ist erreichbar: https://help.mirakl.net/category/api_documentation
  • Eigener Shop (bzw. Liste von Shops) ist angelegt und enthält Admin-Account
  • Variablen gesetzt:
    URL (Marktplatz-Plattform)
    API_KEY
    SHOP_ID



Voraussetzungen II – Logistische Voraussetzungen


Eigener Shop (bzw. Liste von Shops) ist angelegt und enthält Admin-Account
  • Shop-Settings sind vollständig (inklusive Adress-Daten und Kontoverbindung)

Produkte sind angelegt

Angebote sind angelegt

Shop ist aktiv (also sichtbar)

Weitere unterstützende Funktionen:


Bestellprozess - Schritte


Hier finden Sie eine Übersicht darüber, wo die API greifen kann.





Fullfillment-Prozess - Reservierung


Hier finden Sie eine Übersicht über die Schritte im Fullfillment-Prozess.




Bestellprozess - Transaktionshistorie


So stellt sich das im System dar:




Custom fields in Mirakl


1. Order Line

vouchercode
  • Anbieter-spezifischer Code, wird über den Kulturpass zugestellt
  • (type: Text, max 200 Zeichen)

voucherredemptionurl
  • URL auf die Webseite, wo ein Anbieter-Code eingelöst werden kann
  • (type: URL)

vouchervalidto
  • Ablaufdatum des Anbieter-Codes
  • (Date ISO 8601 format)

collected
  • Auftrag: Artikel wurde übergeben/Leistung wurde erbracht
  • (Muss-Feld; type BOOLEAN, true|false)

barcodedata
  • Dateninhalt, der durch den Anbieter-Code repräsentiert wird
  • (type: Text, max 2000 Zeichen)

barcodedisplaytype
  • Anzeigeart für QR-Code/Barcode
  • (Wert aus Liste)

Hinweis: Die Order line ist zu adressieren mit OrderID-1

Beispiel:


2. Shop – Barrierefreiheit des Abholortes

accessibilitywheelchairshop
  • Der Abholort des Produktes ist für Rollstuhlfahrer und Rollstuhlfahrerinnen zugänglich
  • (Zugang ohne Stufen und Hindernisse, Türbreite > 90cm, Aufzüge mindestens 110 cm breit und 140 cm lang)
  • (type BOOLEAN: true|false)

accessibilitytoiletshop
  • Eine für Rollstuhlfahrer und Rollstuhlfahrerinnen geeignete Toilette mit ausreichend Bewegungsfläche ist vorhanden.
  • (type BOOLEAN: true|false)

3. Shop – Barrierefreiheit des Angebots

accessibilityoffer
  • Beschreibende Informationen und Angaben zur Barrierefreiheit des Angebots
  • (type Text: maximal 2000 Zeichen)

accessibilitytoiletshop
  • Zusätzliche Freitextinformationen zur Barrierefreiheit des Angebots. Vorgesehen auch für die Angabe der Kontakt-Details des Anbieters für Fragen zur Barrierefreiheit.
  • (type Text: maximal 2000 Zeichen)




Codes in Mirakl für (Teil-)Stornierungen


Shops können via API OR28  folgende Codes setzen, um Stornierungen zu begründen. Eine Validierung dieses Codes (ob es tatsächlich der betreffende Grund ist) erfolgt nicht.



Sollten Sie weitere Fragen haben, melden Sie sich jederzeit gerne bei uns unter support@kulturpass.de.

Tags