_{^{Archivos > Bsale.js}}

Bsale es un objecto global presente en todos los nuevos templates. Tiene como propósito ser un intermediario en la comunicación con la API de Bsale y herramientas de tracking y brinda información acerca del sitio.

Bsale tiene como única propiedad de instancia un objecto de configuración, el cual puede ser modificado en el archivo config.js.

Bsale.config

Para comunicarse con la API de Bsale:

• getCart()
• addToCart()
• updateCart()
• removeFromCart()
• productClick()
• checkout()

Para enviar eventos personalizados a Google Tag Manager y Facebook Pixel:

• tagmanager()
• pixel()

Helpers:

• createElement()

Obtener items y valor total del carro.

Función que se va a ejecutar cuando se obtenga el carro. Como único argumento recibe un objeto con el carro.

undefined.

Bsale.getCart(function (data) {
    // data es un json con el carro
    // el cual tiene la siguiente estructura: {total: 0, items: 0, mgs: "*/*  "}
})

Agregar un item al carro. Aumáticamente envía el evento a las herramientas de tracking.

Id de la variante del producto.

Cantidad que se desee agregar al carro.

Función que se va a ejecutar cuando responda la API de Bsale. Como único argumento recibe un objeto con la respuesta del servidor.

undefined.

Bsale.addToCart(222, 1, function (data) {
    // data es un json con el status de la petición
    // la cual puede ser "ok", si se agregó correctamente
    // o "non_stock", si no hay stock suficiente, o si la cantidad exede 
    // el máximo de productos que se pueden comprar
})

Actualizar un item en el carro. Aumáticamente envía el evento a las herramientas de tracking.

Id del producto en el carro.

Cantidad para actualizar.

Función que se va a ejecutar cuando responda la API de Bsale. Como único argumento recibe un objeto con la respuesta del servidor.

undefined.

Bsale.updateCart(111, 2, function (data) {
    // data es un json con el status de la petición
    // la cual puede ser "ok", si se agregó correctamente
    // o "non_stock", si no hay stock suficiente, o si la cantidad exede 
    // el máximo de productos que se pueden comprar
})

Remover un item del carro. Aumáticamente envía el evento a las herramientas de tracking.

Id del producto en el carro.

Función que se va a ejecutar cuando responda la API de Bsale. Como único argumento recibe un objeto con la respuesta del servidor.

undefined.

Bsale.removeFromCart(111, function (data) {
    // data es un json con el status de la petición
    // la cual será "ok", si se eliminó correctamente
})

Enviar evento de click en un producto dentro de una colección a las herramientas de tracking.

Id de la variante del producto.

undefined.

Bsale.productClick(222)

Enviar evento de entrada a la vista de chackout a las herramientas de tracking.

undefined.

Bsale.checkout()

Enviar evento personalizado a Google Tag Manager.

Objeto con la información del evento.

undefined.

Bsale.tagmanager({ event: 'purchase', data: { /* datos relevantes al evento */ } })

Enviar evento personalizado a Facebook Pixel.

Nombre del evento.

Objeto con la información relevante al evento.

Opcional. Si se desea enviar un evento personalizado, este parámetro debe ser true, de lo contrario, puede ser omitido.

undefined.

Bsale.pixel('Purchase', { /* datos relevantes al evento */ })

Interfaz para crear elementos HTML.

Tag HTML que se desee crear.

Opcional. Objecto con los atributos del nuevo elemento HTML.

Opcional. Texto o elemento HTML (puede ser un elemento retornado por este mismo método; al agregar clases como atributo, es necesario pasar la propiedad como "className").

Nuevo elemento HTML.

Bsale.createElement('div')                         // => <div></div>
Bsale.createElement('button', { id: 'button' })    // => <button id="button"></button>
Bsale.createElement('h1', null, 'Título')          // => <h1>Título</h1>
Bsale.createElement('div', { className: 'row' }, ( // => <div class="row"><div class="col"></div></div>
  Bsale.createElement('div', { className: 'col' })
))