1. Home
  2. Dokumente
  3. bookyt API Grundlagen
  4. Buchung anlegen

Buchung anlegen

Der API-Aufruf „newBooking“ ermöglicht es dir, eine neue Buchung zu erstellen und liefert ein JSON-Objekt mit Informationen zur erstellten Buchung sowie den weiteren Schritten zurück. Hier ist, wie dieser API-Aufruf funktioniert:

POST Request:

call=newBooking

Parameter:

  • token: Dein API-Token.
  • fahrzeug_id: Die eindeutige Fahrzeug-ID.
  • category_id: Die eindeutige ID der Fahrzeugkategorie.
  • start: UNIX Timestamp für das Startdatum der Buchung.
  • stop: UNIX Timestamp für das Enddatum der Buchung.
  • voucher_code: Gutschein oder Rabattcode (optional).
  • location_id: Die eindeutige Stations-ID.
  • vatrate: MwSt.-Prozentsatz.
  • vatid: ID des hinterlegten MwSt.-Satzes.
  • discount_rate: Prozentualer Rabatt (optional).
  • customer_id: ID des Kunden.
  • customer: Ein JSON-Objekt mit Kundeninformationen, einschließlich Name, Vorname, E-Mail-Adresse, Anrede, Mobilnummer, Adresse, PLZ, Ort, Land und Geburtsdatum.
  • positionen: Ein Array von JSON-Objekten, die Informationen zu den gebuchten Positionen enthalten. Jedes Position-Objekt enthält Typ, Beschreibung, Nettopreis, Artikel-ID und Anzahl.

Beispiel POST Request:

curl -X POST -H "Content-Type: application/json" -d '{
  "call": "newBooking",
  "token": "dein-API-Token",
  "fahrzeug_id": "eindeutige-Fahrzeug-ID",
  "category_id": "eindeutige-Kategorie-ID",
  "start": "Startdatum",
  "stop": "Stopdatum",
  "voucher_code": "Gutschein-oder-Rabattcode",
  "location_id": "eindeutige-Stations-ID",
  "vatrate": "MwSt.-Prozentsatz",
  "vatid": "ID-des-MwSt.-Satzes",
  "discount_rate": "Prozentualer-Rabatt",
  "customer_id": "Kunden-ID",
  "customer": {
    "name": "Name-des-Kunden",
    "firstname": "Vorname-des-Kunden",
    "email": "E-Mail-Adresse-des-Kunden",
    "anrede_id": "Anrede-ID-des-Kunden",
    "mobil": "Mobil-Rufnummer-des-Kunden",
    "adresse": "Adresse-des-Kunden",
    "plz": "PLZ-des-Kunden",
    "ort": "Ort-des-Kunden",
    "land_id": "ID-des-Landes-des-Kunden",
    "geburtsdatum": "Geburtsdatum-des-Kunden"
  },
  "positionen": [
    {
      "type": "ID-des-Artikels",
      "caption": "Beschreibung-des-Artikels",
      "price_net": "Netto-Preis",
      "artikel_id": "ID-des-Artikels",
      "amount": "Anzahl-des-Artikels"
    },
    {
      "type": "ID-des-Artikels",
      "caption": "Beschreibung-des-Artikels",
      "price_net": "Netto-Preis",
      "artikel_id": "ID-des-Artikels",
      "amount": "Anzahl-des-Artikels"
    }
  ]
}' 'https://deine-frontend-url.de/api.php'

Nach dem Absenden dieses POST Requests erstellt die API die Buchung und gibt ein JSON-Objekt zurück, das Informationen zur erstellten Buchung und den weiteren Schritten enthält. Dies kann beispielsweise Informationen zur Zahlung und zur Buchungsbestätigung enthalten.

Dieser API-Aufruf ermöglicht die nahtlose Erstellung von Buchungen über deine Anwendung oder Website.