Zum Hauptinhalt springen
Widget-API
Pavlo avatar
Verfasst von Pavlo
Vor über 2 Monaten aktualisiert

Wir verfügen über eine Liste von Events, auf die Sie zugreifen können, wenn im Widget relevante Aktionen ausgeführt werden. Auf diese Events kann man über das

ZapietEvent-Interface zugreifen.

Um die hier beschriebenen Events zu lauschen, verwenden Sie die Methode window.ZapietEvent.listen(). Diese Methode akzeptiert zwei Argumente:

  • Der Name des Events

  • Eine optionale Rückruffunktion mit der Nutzlast des Events

Beispiel:

window.ZapietEvent.listen("widget_loaded", function() {
alert("Zapiet widget loaded!");
});

Weitere Informationen finden Sie in unserer Widget-API-Dokumentation.


Verfügbare Events

Vorbereitungszeit, Zustellzeitfenster-Limits und bedingte Aktivierung werden über die Widget-API nicht unterstützt.

Die folgenden Events sind in Version 7.0.5 und höher verfügbar:

  • widget_loaded

    • Wird ausgelöst, wenn das Widget vollständig auf die Seite geladen wurde und zur Verwendung bereit ist.

  • selected_method

    • Wird ausgelöst, wenn im Widget eine Checkout-Methode ausgewählt wird.

    • Nutzlasttyp: "delivery" | "pickup" | "shipping"

    • Beispiel:

      window.ZapietEvent.listen("selected_method", function(checkout_method) { 
      switch (checkout_method) {
      case "pickup":
      // Do something when pickup is selected
      break;
      case "delivery":
      // Do something when delivery is selected
      break;
      case "shipping":
      // Do something when shipping is selected
      break;
      }
      });
  • delivery.datepicker.rendered

    • Wird ausgelöst, wenn der Zustellungskalender auf der Seite gerendert wird.

  • delivery.datepicker.opened

    • Wird beim Öffnen des Zustellungskalenders ausgelöst.

  • delivery.timepicker.rendered

    • Wird ausgelöst, wenn die Zustellzeitauswahl auf der Seite gerendert wird.

  • delivery.timepicker.opened

    • Wird ausgelöst, wenn die Zustellzeitauswahl geöffnet wird.

  • pickup.datepicker.rendered

    • Wird ausgelöst, wenn der Abholkalender auf der Seite gerendert wird.

  • pickup.datepicker.opened

    • Wird ausgelöst, wenn der Abholkalender geöffnet wird.

  • pickup.timepicker.rendered

    • Wird ausgelöst, wenn die Abholzeitauswahl auf der Seite gerendert wird.

  • pickup.timepicker.opened

    • Wird ausgelöst, wenn die Abholzeitauswahl geöffnet wird.

  • shipping.datepicker.rendered

    • Wird ausgelöst, wenn der Versandkalender auf der Seite gerendert wird.

  • shipping.datepicker.opened

    • Wird beim Öffnen des Versandkalenders ausgelöst.

  • checkoutEnabled

    • Wird ausgelöst, wenn die Checkout-Schaltfläche aktiviert ist und die Checkout-Parameter bereitstellt.

    • Nutzlasttyp:

      {
      method: "pickup" | "shipping" | "delivery",
      location: {
      id: number,
      company_name: string,
      date_picker_enabled: boolean,
      latitude: string,
      longitude: string,
      address_line_1: string,
      address_line_2: string,
      city: string,
      country: string,
      postal_code: string,
      region: string,
      region_code: string,
      slots: array,
      custom_attribute_1: string,
      custom_attribute_2: string,
      custom_attribute_3: string,
      more_information: string,
      opening_hours: any,
      distance: string,
      limits_enabled: string,
      time_picker_enabled: boolean
      },
      date: string,
      time: string,
      start_time: string,
      slot_id: number,
      postal_code: string
      }
    • Beispiel:

      window.ZapietEvent.listen("checkoutEnabled", function(params) {
      if (params.method == "pickup") {
      console.log("Checkout enabled with Store pickup selected");
      }
      });

Die folgenden Events sind derzeit in der neuesten Version unserer App verfügbar:

  • Zapiet.setCheckoutMethod( "delivery" | "pickup" | "shipping"):

    • Wird für das Auswählen einer Checkout-Methode verwendet: Zustellung, Abholung oder Versand.

  • Zapiet.getSelectedCheckoutMethod():

    • Wird für das Erhalten der ausgewählten Checkout-Methode verwendet.

  • Zapiet.getAvailableCheckoutMethods():

    • Wird für das Erhalten der verfügbaren Checkout-Methoden verwendet.

  • locationSelected

    • Wird immer dann ausgelöst, wenn ein Standort ausgewählt wird, sei es bei Zustellung oder Abholung.

    • Nutzlasttyp:

      {
      method: "pickup" | "shipping" | "delivery",
      location: {
      id: number,
      company_name: string,
      date_picker_enabled: boolean,
      latitude: string,
      longitude: string,
      address_line_1: string,
      address_line_2: string,
      city: string,
      country: string,
      postal_code: string,
      region: string,
      region_code: string,
      slots: array,
      custom_attribute_1: string,
      custom_attribute_2: string,
      custom_attribute_3: string,
      more_information: string,
      opening_hours: any,
      distance: string,
      limits_enabled: string,
      time_picker_enabled: boolean
      }
      }
    • Beispiel:

      window.ZapietEvent.listen("locationSelected", function(params) {
      if (params.method == "pickup") {
      console.log("Pickup location selected: " + params.location.company_name);
      }
      });

Warenkorbattribute

Wir verwenden die Shopify Cart API, um Ihren Bestellungen die erforderlichen Attribute hinzuzufügen.

Liste der möglichen Attribute:

  • Checkout-Method: "pickup" | "delivery" | "shipping"

  • Pickup-Location-Id

  • Pickup-Location-Company

  • Pickup-Location-Address-Line-1

  • Pickup-Location-Address-Line-2

  • Pickup-Location-City

  • Pickup-Location-Region

  • Pickup-Location-Postal-Code

  • Pickup-Location-Country

  • Pickup-Date

  • Pickup-Time

  • Delivery-Location-Id

  • Delivery-Date

  • Delivery-Time

  • Delivery-Slot-Id (Nur interne Verwendung)

  • Shipping-Date

  • Custom-Attribute-1

  • Custom-Attribute-2

  • Custom-Attribute-3

Hat dies deine Frage beantwortet?