Anlage und Import von fremdverwalteten Angeboten

Vorbemerkungen

Fremdverwaltete Angebote können nicht über den Frisbii Media Checkout erworben werden. Um eine Bestellung eines fremdverwalteten Angebots durchzuführen, kann ein Import via API genutzt werden.

Hinweis:

Durch einen Import entsteht sowohl eine Bestellung als auch ein fremdverwaltetes Abonnement. Fremdverwaltete Abonnements unterscheiden sich von regulären Abonnements. Eine Beschreibung dazu findet sich hier.

Angebotsanlage

Alle Angebote, welche extern verwaltet werden können, verfügen über eine entsprechende Option in der Angebotsanlage.

Um ein Angebot als extern verwaltet zu definieren, sind folgende Schritte notwendig:

• Öffnen des Menüpunkts Produkte / Angebote.

• Klick auf Button "Angebot erstellen".

• Gewünschte Angebotsart auswählen und Button "erstellen" klicken.

• Im Bereich "Externe Verwaltung" des Anlageformulars die gewünschte Option auswählen.
  Der Bereich findet sich je nach Angebotsart entweder am Ende des Formulars oder im Reiter "Grunddaten"

• Speichern der Angebotsanlage

Import einer Bestellung

Um eine Bestellung eines fremdverwaltetes Angebots durchzuführen, ist ein Import der Bestellung über die API notwendig. Der entsprechende Endpunkt bzw. Request ist in der API-Dokumentation beschrieben.  

Kundendaten  Um einen Import durchzuführen, muss der Kunde, für den die Bestellung erstellt wird, bereits in Frisbii Media vorhanden sein.

Ist dies nicht der Fall, muss der Kunde vor dem Import über einen zusätzlichen Request angelegt werden. Dazu sind folgende Schritte notwendig:

• POST-Request zur Erstellung eines Kunden-Datensatz

• Notwendige Daten im Request sind:

  • email
    die E-Mailadresse des Kunden als eindeutiges Identifizierungsmerkmal des Datensatzes

  • language
    die Sprache des Kunden

• die anderen Felder können optional befüllt werden

Importdaten  Notwendige Daten im Request für die Durchführung eines Imports sind:  

• externalSystemId
  Eindeutige Id aus dem führenden Drittsystem. Wird in Frisbii Media an der Bestellung und am Abonnement vermerkt.

• Frisbii MediaOfferId
  Die zu nutzende Frisbii Media-Bestellnummer

• invoiceCustomerId
  Die Frisbii Media-Kundenummer

• quantity
  Die gewünschte Anzahl des Angebots

• startDate
  Das Startdatum für Abonnements. Bestimmt gleichzeitig des Startdatum für die Zugriffsrechte in Frisbii Media.

• paymentMethod
  Die Zahlungsmethode, welche für die Bestellung  genutzt wurde.

Daneben stehen noch weitere Datenfelder zur Verfügung. Eine komplette Liste findet sich in der API-Dokumentation.  

Alle durchgeführten Importe werden in einem Log protokolliert.  

Hinweis:

Ein Order-Import wird asynchron ausgeführt. In der Response zu einem Import wird ggf. eine promiseId ausgegeben, welche zur Identifizierung genutzt werden kann.  

Aktualisierung einer Bestellung

Fremdverwaltete Angebote können nicht direkt im Frisbii Media Backend aktualisiert werden. Für jede Aktualisierung ist ein erneuter Import mit angepassten Daten notwendig.  

Durchführung einer Aktualisierung:  

• Zur Aktualisierung wird der selbe Endpunkt wie beim Import verwendet.

  • Anpassung der gewünschten Daten im requestbody

  • setzen des Felds "endDate" führt zum Ende eines Abonnements

  • Update der Zahlungsmethode durch Aktualisierung des Felds "paymentMethod"