API do Widget | Zapiet Help Center

Temos uma lista de eventos que você pode acessar quando ações relevantes são realizadas no widget. Esses eventos são acessíveis através da interface ZapietEvent.

Para ouvir os eventos descritos aqui, use o método window.ZapietEvent.listen(). Este método aceita dois argumentos:

O nome do evento
Uma função de callback opcional com o payload do evento

Exemplo:

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

Consulte nossa Documentação da API do Widget para mais informações.

Eventos disponíveis

O tempo de preparação, limites de horários e ativação condicional são suportados através da API de locais.

Os seguintes eventos estão disponíveis na versão 7.0.5 e acima:

widget_loaded
- Acionado quando o widget termina de carregar na página e está pronto para ser usado.

selected_method

Acionado quando um método de checkout é selecionado no widget.
Tipo de payload: "delivery" | "pickup" | "shipping"

Exemplo:

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
- Acionado quando o calendário de entrega é renderizado na página.

delivery.datepicker.opened
- Acionado quando o calendário de entrega é aberto.

delivery.timepicker.rendered
- Acionado quando o seletor de tempo de entrega é renderizado na página.

delivery.timepicker.opened
- Acionado quando o seletor de tempo de entrega é aberto.

pickup.datepicker.rendered
- Acionado quando o calendário de recolha é renderizado na página.

pickup.datepicker.opened
- Acionado quando o calendário de recolha é aberto.

pickup.timepicker.rendered
- Acionado quando o seletor de tempo de recolha é renderizado na página.

pickup.timepicker.opened
- Acionado quando o seletor de tempo de entrega é aberto.

shipping.datepicker.rendered
- Acionado quando o calendário de envio é renderizado na página.

shipping.datepicker.opened
- Acionado quando o calendário de envio é aberto.

checkoutEnabled

Acionado quando o botão de checkout é ativado e fornece os parâmetros de checkout.

Tipo de payload:

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

Exemplo:

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

Os seguintes eventos estão atualmente disponíveis na versão mais recente do nosso aplicativo:

Zapiet.setCheckoutMethod( "delivery" | "pickup" | "shipping"):
- Usado para selecionar um método de checkout: Envio, Entrega ou Recolha.
Zapiet.getSelectedCheckoutMethod():
- Usado para obter o método de checkout selecionado.
Zapiet.getAvailableCheckoutMethods():
- Usado para obter métodos de checkout disponíveis.

locationSelected

Acionado sempre que um local é selecionado, seja para entrega ou recolha.

Tipo de payload:

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

Exemplo:

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

Atributos do carrinho

Usamos a API do Carrinho Shopify para adicionar os atributos necessários aos seus pedidos.

Lista dos atributos possíveis:

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 (Internal use only)
Shipping-Date
Custom-Attribute-1
Custom-Attribute-2
Custom-Attribute-3