Passer au contenu principal
API du Widget
Sandy Jolin avatar
Écrit par Sandy Jolin
Mis à jour il y a plus d’une semaine

Nous avons une liste d'événements auxquels vous pouvez accéder lorsque des actions pertinentes sont entreprises dans le widget. Ces événements sont accessibles via l'interface ZapietEvent.

Pour écouter les événements décrits ici, utilisez la méthode window.ZapietEvent.listen().
Cette méthode accepte deux arguments :

  • Le nom de l'événement

  • Une fonction de rappel facultative avec la charge utile de l'événement

Exemple:

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

Consultez notre documentation sur l'API du Widget pour plus d'informations.


Événements disponibles

Le temps de préparation, les limites de créneaux horaires et l'activation conditionnelle sont pris en charge via l'API d'emplacement.

Les événements suivants sont disponibles dans la v7.0.5 et les versions ultérieures :

  • widget_loaded

    • Déclenché lorsque le widget a fini de se charger sur la page et est prêt à être utilisé.

  • selected_method

    • Déclenché lorsqu'une méthode de paiement est sélectionnée dans le widget.

    • Type de charge : "delivery" | "pickup" | "shipping"

    • Exemple:

      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

    • Déclenché lorsque le calendrier de livraison s'affiche sur la page.

  • delivery.datepicker.opened

    • Déclenché à l'ouverture du calendrier de livraison.

  • delivery.timepicker.rendered

    • Déclenché lorsque le sélecteur d'heure de livraison s'affiche sur la page.

  • delivery.timepicker.opened

    • Déclenché à l'ouverture du sélecteur d'heure de livraison.

  • pickup.datepicker.rendered

    • Déclenché lorsque le calendrier de collecte s'affiche sur la page.

  • pickup.datepicker.opened

    • Déclenché à l'ouverture du calendrier de ramassage.

  • pickup.timepicker.rendered

    • Déclenché lorsque le sélecteur d'heure de ramassage s'affiche sur la page.

  • pickup.timepicker.opened

    • Déclenché à l'ouverture du sélecteur d'heure de ramassage.

  • shipping.datepicker.rendered

    • Déclenché lorsque le calendrier d'expédition s'affiche sur la page.

  • shipping.datepicker.opened

    • Déclenché à l'ouverture du calendrier d'expédition.

  • checkoutEnabled

    • Déclenché lorsque le bouton de paiement est activé et fournit les paramètres de paiement.

    • Type de charge:

      {
      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
      }

    • Par exemple:

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

Les événements suivants sont actuellement disponibles sur la dernière version de notre application:

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

    • Utilisé pour sélectionner une méthode de paiement : Expédition, Livraison ou Ramassage.

  • Zapiet.getSelectedCheckoutMethod():

    • Utilisé pour obtenir la méthode de paiement sélectionnée.

  • Zapiet.getAvailableCheckoutMethods():

    • Utilisé pour obtenir les méthodes de paiement disponibles.

  • locationSelected

    • Déclenché chaque fois qu'un emplacement est sélectionné, que ce soit pour la livraison ou le ramassage.

    • Type de charge:

      {
      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
      }
      }

    • Par exemple:

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


Attributs du panier

Nous utilisons l'API du panier Shopify pour ajouter les attributs nécessaires à vos commandes.

Liste des attributs possibles:

  • 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 (Utilisation interne uniquement)

  • Shipping-Date

  • Custom-Attribute-1

  • Custom-Attribute-2

  • Custom-Attribute-3

Avez-vous trouvé la réponse à votre question ?