Checkout Link

Lerne wie du einen Checkout Link erstellst und an deine Kunden sendest.

Mit einem Checkout Link kannst du einen vorkonfigurierten Warenkorb für ein Produkt erstellen und an deine Kunden senden. Der Kunde kann dann direkt zur Kasse gehen und den Kauf abschließen.

​

Checkout Link erstellen

1. Produkt auswählen

   Wähle das Produkt in deinem Produkt-Katalog aus, erstelle einen Preis wenn noch nicht geschehen, und klicke auf den Button “Checkout Link erstellen”.

2. Nach Bestellabschluss einrichten

   Wähle unter “Nach Abschluss” eines der Optionen aus, um festzulegen, was nach dem Kauf passieren soll.

   

   • Standard-Bestätigungsseite: Der Kunde wird auf die Standard-Bestätigungsseite weitergeleitet, und erhält eine Übersicht über seine Bestellung und die dazugehörige Rechnung.
   • Benutzerdefinierte Weiterleitung: Der Kunde wird auf eine von dir festgelegte URL weitergeleitet.
   • Benutzerdefinierte Bestätigungsnachricht: Der Kunde wird auf die Standard-Bestätigungsseite weitergeleitet, und erhält eine von dir festgelegte Bestätigungsnachricht angezeigt.

   Bei der Verwendung einer benutzerdefinierten Weiterleitung kannst du die URL mit Platzhaltern versehen, die durch URL Parameter ersetzt werden. Weiteres findest du unter Metadaten hinzufügen.

   Zurück zum Anbieter-Button anzeigen: Aktiviere diese Option, wenn du möchtest, dass der Kunde nach dem Kauf auf der Standard-Bestätigungsseite einen Button sieht, um zurück zu deinem Anbieter zu gelangen.

​

Rabattcodes erlauben

Unter “Weitere Optionen” kannst du festlegen, ob der Kunde einen Rabattcode eingeben kann. Aktiviere diese Option, wenn du möchtest, dass der Kunde einen Rabattcode eingeben kann. Andernfalls wird das Feld ausgeblendet.

​

Testzeitraum festlegen

Unter “Weitere Optionen” kannst du für wiederkehrende Produkte festlegen, ob ein Testzeitraum für das Produkt gelten soll.

Aktiviere diese Option, wenn du möchtest, dass der Kunde das Produkt vor dem Kauf testen kann. Der Betrag wird erst nach Ablauf des Testzeitraums fällig.

Wenn im Preis der Testzeitraum über Testphase erlauben ausgeschlossen ist, wird diese Option ignoriert.

​

Laufzeiten festlegen

Unter “Weitere Optionen” kannst du für wiederkehrende Produkte festlegen, welche Vertrags- & Kündigungszeiträume für das Produkt gelten. Die Laufzeiten werden anschließend in das Abonnement überführt.

Für einmalige Produkte ist diese Option ohne Bedeutung.

Solltest du keine Laufzeiten festlegen, wird als Vertragslaufzeit die Abrechnungsperiode verwendet und als Kündigungsfrist 1 Tag.

​

Unternehmensangabe erzwingen

Unter “Weitere Optionen” kannst du festlegen, ob der Kunde verpflichtet ist, eine Unternehmensangabe zu machen. So kannst du sicherstellen, dass du nur an Unternehmen verkaufst.

Hierfür aktiviere die Option “Unternehmensangabe erzwingen”.

​

Menge veränderbar machen

Unter “Weitere Optionen” kannst du festlegen, ob der Kunde die Menge des Produkts im Warenkorb nachträglich verändern kann.

Aktiviere diese Option, indem du die Checkbox “Menge veränderbar” aktivierst. Hiermit kann ein Produkt nicht aus dem Warenkorb entfernt werden, sondern nur die Menge verändert werden.

​

Metadaten hinzufügen

Du kannst Metadaten an den Checkout Link anhängen, um zusätzliche Informationen zu übergeben.

Diese Metadaten werden:

• als Weiterleitungsparameter an die benutzerdefinierte Weiterleitung angehängt
• als Platzhalter in der benutzerdefinierten Weiterleitung ersetzt
• im Webhook als metadata-Feld übergeben

​

Metadaten anhängen

Um Metadaten an den Checkout Link anzuhängen, füge sie als URL-Parameter hinzu, z.B. https://fynn.coreapi.io/checkout-link/xxxxxxxx?metadata[key]=value&metadata[key2]=value2.

Es ist zudem möglich ein mehrdimensionales Array zu übergeben, indem du den Schlüssel mit eckigen Klammern umschließt, z.B. metadata[key][subkey]=value.

​

Platzhalter in der benutzerdefinierten Weiterleitung

Du kannst Platzhalter in der benutzerdefinierten Weiterleitung verwenden, die durch Metadaten ersetzt werden. Um ein angegebenes Metadatum in der benutzerdefinierten Weiterleitung zu verwenden, füge es in geschweiften Klammern hinzu, z.B. {{metadataKey}}.

Wenn du eine Mandanten-fähige Anwendung betreibst, und bspw. bei Weiterleitung auf eine benutzerdefinierte URL des Mandanten weiterleiten möchtest, kannst du die Mandanten-ID als Metadatum an den Checkout Link anhängen und als Platzhalter in der benutzerdefinierten Weiterleitung verwenden.

Beispiel URL: https://{{mandantId}}.example.com/checkout-success

Beispiel Checkout-URL: https://fynn.coreapi.io/checkout-link/xxxxxx?metadata[mandantId]=acmegmbh

​

Webhooks

Die Metadaten werden im Webhook als metadata-Feld übergeben.

{
    "metadata": {
        "key": "value",
        "key2": "value2"
    }
}

​

Checkout Session erstellen

Standardmäßig wird bei Verwendung des Checkout Links eine neue Checkout Session erstellt. Es kann jedoch sinnvoll sein, dass nur eine Checkout Session erstellt wird, wenn du:

• mehrere Produkte in einem Warenkorb bündeln möchtest
• den Checkout Link mehrfach verwenden möchtest

Um eine Checkout Session zu erstellen, füge den Parameter session=true hinzu, z.B. https://my-tenant.coreapi.io/checkout-link/xxxxxxxx?session=true.

Wenn eine Checkout Session erstellt wurde und ein Checkout Link ohne session=true aufgerufen wird, wird eine einmalige unabhängige Checkout Session erstellt.

Die Checkout Session ist 24 Stunden gültig. Nach Ablauf dieser Zeit wird der Warenkorb geleert.

​

Checkout Session abrufen

Um die Checkout Session abzurufen, ohne ein weiteres Produkt hinzuzufügen, rufe folgende API-Route auf: https://[tenant-username].coreapi.io/public/checkout/cart/current. Ersetze [tenant-username] durch deinen Tenant-Namen.

Anschließend wird zur aktuellen Checkout Session weitergeleitet.

​

Käuferdaten vorbelegen

Wenn der Käufer noch kein Kunde in Fynn ist, kannst du im Checkout-Formular die E-Mail-Adresse sowie Vor- und Nachname der Rechnungsadresse vorbelegen. Der Käufer kann die Werte ändern. Adresse und Zahlungsmethode fragt der Checkout wie gewohnt ab.

Nutze die Vorbelegung, wenn du den Kunden nicht vorab anlegen willst. Legst du den Kunden vorher über POST /customers an, geht der Checkout davon aus, dass die Adresse des Kunden bereits vorliegt.

​

Über die API

Übergib beim Erstellen des Warenkorbs das Objekt customerPrefill. Alle drei Felder sind optional. Der Endpunkt benötigt die Berechtigung cart:write.

curl -X POST https://coreapi.io/api/checkout-links/{checkoutLinkId}/cart \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerPrefill": {
      "email": "[e-mail]",
      "firstName": "Erika",
      "lastName": "Mustermann"
    },
    "metadata": { "externalUserId": "123" }
  }'

Die Antwort enthält cartId, customerId und url. Leite den Käufer auf die url weiter.

​

Über den Checkout Link

Hänge die Werte als URL-Parameter prefill[...] an, z.B. https://fynn.coreapi.io/checkout-link/xxxxxxxx?prefill[email]=kunde%40example.com&prefill[firstName]=Erika&prefill[lastName]=Mustermann. Kodiere die Werte URL-konform. Die Parameter lassen sich mit metadata[...] und session=true kombinieren.

​

Regeln

• Gehört die vorbelegte E-Mail-Adresse bereits zu einem Kunden, bietet der Checkout den Login per Einmalcode an, sobald der Käufer mit dem Formular interagiert.
• Wird zusätzlich customerId übergeben, wird customerPrefill ignoriert. Es gelten die gespeicherten Daten des Kunden.
• Eine ungültige E-Mail-Adresse im API-Aufruf führt zu einem 422. Im Checkout Link wird ein ungültiger Wert ignoriert.
• Bei session=true behält ein bestehender Warenkorb seine Daten, wenn er bereits einen Kunden, eine E-Mail-Adresse oder eine gesetzte Vorbelegung hat. Folgt der Käufer in derselben Session einem weiteren Checkout Link, bleibt die bestehende Vorbelegung erhalten.