# Tipos de eventos

Se ha añadido un producto al carrito.

# Parámetros

type: EventAddedToCart
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122
quantity: La cantidad de unidades de este producto añadidas al carrito. Si no se especifica, el valor por defecto es 1

Se ha quitado un producto del carrito.

# Parámetros

type: EventRemovedFromCart
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122
quantity: La cantidad de unidades de este producto retiradas del carrito. Si no se especifica, el valor por defecto es 1

Se ha añadido un producto a la lista de productos deseados.

# Parámetros

type: EventAddedToWishlist
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122

Se ha quitado un producto de la lista de productos deseados.

# Parámetros

type: EventRemovedFromWishlist
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122

Se ha comprado un producto. Debe enviarse cuando el cliente manifiesta su voluntad de comprar y pagar por el producto, aunque el pago aún no se haya realizado o haya fallado. Por ejemplo: Al pulsar el botón "Pagar" en el carrito.

# Parámetros

type: EventSale
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122
quantity: La cantidad de unidades de este producto compradas. Si no se especifica, el valor por defecto es 1

Se ha solicitado la devolución de un producto.

Debe enviarse cuando el cliente solicita la devolución, aunque ésta no sea aceptada, o finalmente no se produzca por cualquier motivo.

# Parámetros

type: EventReturnRequested
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122

Se ha visualizado la página donde se muestran los detalles sobre un producto en concreto.

# Parámetros

type: EventProductViewed
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122

Se ha visualizado la página donde se muestran los productos de una categoría en concreto.

# Parámetros

type: EventCategoryViewed
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
categoryCode: Vuestro código interno identificador de la categoría. Debe coincidir con el que especificaste al añadir productos a Biteral. Por ejemplo: MC418292

Se ha visualizado la página donde se muestran los productos de una marca en concreto.

# Parámetros

type: EventBrandViewed
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
brandCode: Vuestro código interno identificador de la marca. Debe coincidir con el que especificaste al añadir productos a Biteral. Por ejemplo: OW142302

Se ha realizado una búsqueda de productos.

Este evento debe enviarse si vuestro web tiene su propio buscador textual. Si utilizáis el buscador natural de Biteral, no es necesario enviar este evento cuando se produce una búsqueda desde allí.

# Parámetros

type: EventSearch
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
query: El texto de la búsqueda tal como lo escribió el cliente.

Se ha filtrado un listado de productos. Debe enviarse, por ejemplo, cuando el cliente especifica un filtro de productos por color, por precio, por material, etcétera.

# Parámetros

type: EventFilterApplied
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
filterName: El nombre del filtro, por ejemplo: color
filterValue: El valor del filtro, por ejemplo: rojo

Se ha cambiado el orden de un listado de productos. Debe enviarse cuando, por ejemplo, el cliente ordena un listado de productos por precio, por novedad, etcétera.

# Parámetros

type: EventOrderApplied
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
orderDescription: La descripción del orden aplicado. Puede ser cualquier palabra o frase que describa el orden, por ejemplo: price, newest products first, screen size, etcétera.
orderDirection: Si es relevante, la dirección del orden: asc para dirección ascendente, desc para dirección descendente

Se ha aplicado un cupón de descuento.

Debe enviarse sólo cuando el código del cupón introducido por el cliente haya sido confirmado como válido.

# Parámetros

type: EventCouponApplied
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828

Se ha escrito una review sobre un producto.

# Parámetros

type: EventReviewWritten
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122
review: El texto de la review, tal como la escribió el cliente.

Se ha solicitado una alerta de stock disponible sobre un producto.

Debe enviarse cuando un cliente solicita ser notificado cuando un producto vuelva a estar disponible para la compra, normalmente, porque encontró el producto pero no estaba disponible para comprar en ese momento debido a falta de stock.

# Parámetros

type: EventStockAlertRequested
timestamp: El momento en el que se produjo el evento. Si no lo especificas, se utilizará el momento actual. Al utilizar el SDK para PHP, un objeto DateTimeImmutable. Al utilizar la API, una cadena ISO 8601.
customerCode: Vuestro código interno identificador del cliente. Debe coincidir con el que especificaste al añadir el cliente a Biteral. Por ejemplo: JD934828
productCode: Vuestro código interno identificador del producto. Debe coincidir con el que especificaste al añadir el producto a Biteral. Por ejemplo: N30122
review: El texto de la review, tal como la escribió el cliente.