Envío de eventos

El checkout emite eventos mediante las interacciones del usuario y las funciones internas.

Cada acción realizada por el usuario o por cada función ejecutada por el checkout emitirá un evento con un nombre único dentro onEventDispatch que es parte configuración, puede ser usado para llevar un control del comportamiento de los usuarios estos eventos también sirven para redirigir o realizar alguna acción o función según lo vea necesario el comercio.

Flujo de eventos

La imagen FlujoEv representa el orden del comportamiento del checkout y la emisión de sus eventos durante todo el ciclo de la compra. Puedes observar con más detalle dando clic sobre la imagen.

28922892

FlujoEv

¿Cómo obtener los eventos?

OnEventDispatch Es una función que devuelve event y data, donde event corresponde al nombre del evento y data a la información correspondiente al evento.
En el siguiente ejemplo se muestra cómo después de emitirse el evento purchase, redirige al usuario a la página "https://www.somepage.com/orderCompleted".

const config = {
  apiKey: "...",
  env: "production",
  orderToken: "...",
  onEventDispatch: function (event, data) {
    if (event === 'purchase') {
        window.location.href="https://www.somepage.com/orderCompleted";
    }
  }
};

Información de los eventos

Nombre del Evento Acción
accountCreated Pagar y se crea el usuario
accountDataNotSaved Se procesa el Pago pero no se pudo guardar los datos del usuario
accountDataSaved Pagar, se crea el usuario y a la vez se guardan los datos
addressConfirmed Hay cobertura en la direccion seleccioda
addressLookup Abre el mapa
addressNull No ingresa ninguna dirección en el buscador de mapa
addressOutOfCoverage No hay cobertura en la dirección colocada
backClick Ir “Atrás” o retroceder es diferente a Salir de Pago
billingAddressCountrySet Emite "uncheckSameAddress", y se ingresa el país
billingAddressPostalCodeSet Emite "uncheckSameAddress" y se ingresa el Código Postal
billingAddressStreetSet Emite "uncheckSameAddress" y se ingresa una dirección
cardIdentityDocumentSet Ingresa número de identidad del tarjeta habiente de la tarjeta de débito
cardNameSet Ingresa el nombre del tarjeta habiente de la tarjeta de débito
cardNumberSet Ingresa un valor al número de tarjeta tarjeta de débito
cashChangeSet Ingresa un valor al solicitar cambio del método de pago efectivo
changeAddress Cambia dirección de entrega
changeStore Cambia de tienda
checkoutDineIn El shipping type no es "pickup" y es "in store"
checkoutPickup El shipping es "pickup" y es "in store" al abrir el checkout
checkoutQuit Cierra el checkout
checkoutStarted Abre el checkout
checkoutSTRedisign Abre el checkout
checkSameAddress Selecciona el check "Utilizar la misma dirección de envío en mi facturación"
checkSaveInformation Seleccionar el check "Guardar tu información para futuras compras"
contactDetailsEntered Los campos email, nombre, apellido, celular y documento de identidad están verificados
continueToDeliveryTime ¨Continuar¨ en la pantalla de Datos a Entrega
continueToPayment Continuar a pagar
continueToShippingMethod Continuar a envío
couponFail Código del cupón es invalido
couponRemove Remover un cupón
couponRemoveFail Falla al remover un cupón
couponSet El usuario ingresa el código del cupón, y le da clic al icono de agregar cupón
couponSuccess Código del cupón agregado es válido
createAddress Cuando se completa la orden
dateScheduleDTSet Ingresar y verificar la fecha de programación de la órden
DeliveryTimeSet Ejecutar un trigger en los parámetros el deliveryTime [Programada, Inmediata]
docIdEntered Verifica el número de identidad
docIdInitiated Cursor el número de identidad
docIdUpdateEntered Verifica el número de identidad al actualizar
docIdUpdateInitiated Cursor sobre el número de identidad a actualizar
emailEntered Verifica el email
emailInitiated Cursor sobre el email
emailUpdateEntered Verifica el email al actualizar
emailUpdateInitiated Cursor sobre email a actualizar
expirationDateSet Ingresa fecha de vencimiento de la "Tarjeta de Débito"
guestCheckout Paga y no se pudo guardar los datos del usuario invitado
hourScheduleDTSet Coloca y queda verificada la hora de programación de la orden
houseAptCreateEntered Agrega referencia en la dirección
lastNameEntered Verifica el apellido
lastNameInitiated Cursor sobre apellido
lastNameUpdateEntered Verifica el apellido a actualizar
lastNameUpdateInitiated Cursor sobre apellido a actualizar
login Autentifica un usuario exitosamente
loginAtCheckout Código ingresado es válido e inicia sesión con éxito
mapMoved Desplazamiento por el mapa
missingAccountData Faltan datos del usuario
movedToLocation Ubicación actual
nameEntered Verifica el nombre
nameInitiated Cursor Sobre el nombre
nameUpdateEntered Verifica el nombre a actualizar
nameUpdateInitiated Sobre el nombre a actualizar
newAddressConfirmed Coloca una dirección y si hay cobertura al agregar una nueva dirección
newAddressLookup Ingresa una nueva dirección
newAddressNull No ingresa ningun valor en el campo de agregar nueva dirección
otpAccepted Ingresa el código válido para hacer un "login" directo
otpLoginLoaded Abre la vista para ingresar el código de acceso
otpRejected El código OTP ingresado no es válido
otpSent Ingresa un correo existente
paymentRedirect Pagar y la orden tiene una URL externa de pago
phoneEntered Verifica el celular
phoneInitiated Cursor sobre celular
phoneUpdateEntered Verifica el celular a actualizar
phoneUpdateInitiated Sobre celular a actualizar
processing Pagar y procesa la orden
purchase Pagar y se completa la orden
purchaseError Igual que "rejected", cuando no se pudo procesar la orden
rejected Pagar y hay un error al procesar la orden.
sameDayDeliveryTimeSet Selecciona "entrega inmediata" (Preseleccionado), validación en “Continuar” de la pantalla de Entrega a Pago
scheduleDeliveryTimeSet Selecciona "programada", validación en “Continuar” de la pantalla de Entrega a Pago
securityCodeSet Ingresa un valor al CVV/CVC de la "Tarjeta de Débito"
selectShippingMethod Selecciona un método de envío
signOutAtCheckout Sobre el texto para "Cambiar de Cuenta"
storePickUpConfirmed Verifica que hay dirección de recogida
tpvPaymentAccepted “Enviar terminal”
tpvPaymentOption Abre la pantalla de recuperación de la órden
uncheckSameAddress Deselecciona el check de "Utilizar la misma dirección de envío en mi facturación"
uncheckSaveInformation Deselecciona el check de "Guardar tu información para futuras compras"
userAccountUpdated Actualiza los datos del usuario y se realiza correctamente
voucher Teniendo "OXXO" como método de pago y al pagar, te redirecciona a la vista del (Voucher)

Did this page help you?