Skip to main content

DataLayer

Eventos E-commerce

info

A documentação abaixo vale para a configuração de otabuilder_v2, que precisa ser configurada no cadastro de páginas, dentro do Niara.

tip

Consulte o changelog dos eventos do data layer para acompanhar a evolução desses eventos ao longo do tempo.

Parâmetros principais

Os eventos de e-commerce compartilham um conjunto de parâmetros que aparecem em múltiplos eventos. Abaixo a descrição dos mais relevantes:

Parâmetros de contexto da busca

ParâmetroDescrição
versionBEVersão utilizada (otabuilder_v1 ou otabuilder_v2)
langIdioma selecionado pelo usuário (ex: pt-BR, en, es)
checkIn / check_inData de entrada no formato YYYYMMDD
checkOut / check_outData de saída no formato YYYYMMDD
couponCódigo de promoção utilizado na busca
numberAdultsTotal de adultos na busca
numberChildrenTotal de crianças na busca
daysAdvanceQuantos dias de antecedência a reserva foi feita
isRemarkIndica se é remarketing

Parâmetros de hotel/cadeia hoteleira

ParâmetroDescrição
hotelIdID do hotel
hotelNameNome do hotel
chainIdID da cadeia hoteleira
chainNameNome da cadeia hoteleira
ratingStarsClassificação em estrelas do hotel
numberRoomsNúmero de quartos na reserva
locationCidade do hotel
niaraHotelIdID completo do hotel no formato Niara (HOTEL_OMNI_XXXXX)
niaraChainIdID completo da cadeia hoteleira no formato Niara (CHAIN_OMNI_XXXXX)
clientNameNome do storefront/cliente
clientProjectID do projeto/landing page

Parâmetros de dados do usuário

Esses parâmetros só vêm preenchidos quando o usuário está logado ou já preencheu seus dados no checkout. Caso contrário, retornam null/undefined.

ParâmetroDescrição
firstName / lastNameNome e sobrenome do usuário logado ou preenchido no checkout
userEmailE-mail do usuário
userTelTelefone do usuário
userDocCPF do usuário
userPersonIdID interno do usuário na plataforma Niara
userNationalityNacionalidade do usuário
userCountryPaís do usuário
userDobData de nascimento (YYYY-MM-DD)
userVatNumberCNPJ (para empresas)
userCorporateNameRazão social
userBrandNameNome fantasia

Parâmetros do objeto ecommerce

ParâmetroDescrição
currencyCódigo da moeda principal da transação (ex: BRL)
valueValor total do carrinho
payment_typeFormas de pagamento concatenadas com /. Vazio "" no passo 2. No passo 3 as formas de pagamentos podem vir descritivas (ex: "Cartão de crédito", "Cartão de crédito / POINTS", "Pix") e no passo Purchase virá com identificador (ex: "CREDITCARD", "CREDITCARD / POINTS", "PIX"). "POINTS" pode ser tanto pontos como cashback.
paymentsArray com o detalhamento de cada pagamento. Presente no passo 3 e Purchase. Cada elemento contém: type (forma de pagamento), value (valor pago nessa forma) e currency (moeda).
transaction_idID da reserva gerada. Presente apenas no evento Purchase (ex: "RES064384-10027")
taxTotal de impostos/taxas. Presente no Purchase

Parâmetros de item (ecommerce.items[])

ParâmetroDescrição
item_idID do produto. Para acomodações, é o ID numérico do tipo de quarto. Para experiências, é o ID da experiência.
item_nameNome do produto
item_brandNome do hotel ao qual o produto pertence
item_categoryCategoria do produto: Hotel (na listagem), Accommodation (acomodação/quarto), EXTRA (experiência)
item_variantNome da tarifa (para hospedagens) ou variante selecionada (para experiências)
pricePreço médio por noite (acomodações) ou preço total (extras)
quantityNúmero de noites reservadas — para acomodações (Accommodation). Quantidade de experiências adicionadas — para extras (EXTRA), normalmente 1 por item.
indexPosição do item na lista
affiliationSistema de origem do produto (ex: Omnibees)
couponCupom/promoção aplicado ao item
discountValor do desconto aplicado (positivo)
currencyCódigo da moeda do item (ex: BRL, USD)
item_availabilityDisponibilidade do item (Available for Sale)
item_rate_idID da tarifa no sistema de origem
item_list_nameNome da lista onde o item foi visto (Hotel List, Search Results)
item_list_idID da cadeia hoteleira
item_category2Classificação em estrelas do hotel
item_category3Tipo do item (hotel)
check_in / check_outDatas de entrada e saída específicas do item
locationCidade do hotel do item

Parâmetros antigos (old support)

São campos no formato legado do GA3 Enhanced Ecommerce, mantidos por compatibilidade junto com os campos equivalentes do GA4. Não devem ser usados em novas integrações.

ParâmetroDescriçãoEventos onde aparece
currencyCodeDuplicata de currency, dentro de ecommerce. Mesmo valor, mantido pelo formato antigo.Pesquisa por destino/cadeia hoteleira, Hotel Details, Add to Cart, Remove from Cart, Início do checkout (Passo 1), Dados de pagamento (Passo 2), Reservar (Passo 3), Purchase, Sem resultados
impressionsLista de produtos exibidos no formato antigo (um item por produto, com name, id, price, category, brand, list, position). Equivalente a ecommerce.items. Vem vazio ([]) no evento Sem resultados. No evento Homepage este campo fica no nível raiz do evento (fora de ecommerce); nos demais, fica dentro de ecommerce.Homepage, Pesquisa por destino/cadeia hoteleira, Hotel Details, Sem resultados
checkoutObjeto dentro de ecommerce representando o passo de checkout no formato antigo. Contém actionField.step (1, 2 ou 3; no passo 3 também vem option com a forma de pagamento), products (lista de produtos no formato antigo) e guestData (email, name, phone do comprador).Início do checkout (Passo 1), Dados de pagamento (Passo 2), Reservar (Passo 3)
purchaseObjeto dentro de ecommerce representando a transação concluída no formato antigo. Contém actionField (id, revenue, tax, shipping, affiliation, coupon, currency) e products (lista de produtos no formato antigo).Purchase

1. Homepage

  • Nome do evento: ecommerceHomepage
  • Acionadores:
    • Quando o usuário acessa a homepage do otabuilder

O parâmetro ecommerce.items contém um item para cada hotel destacado na homepage via widget do tipo "HOTEL".

{
"event": "ecommerceHomepage",
"eventDetails": {
"category": "Ecommerce",
"action": "Home page"
},
"versionBE": "otabuilder_v2",
"lang": "pt-BR",
"location": "São Paulo",
"isRemark": false,
"isLoggedIn": true,
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"ecommerce": {
"items": [
{
"item_name": "Niara (Ambiente de Testes) - HOTEL NÃO É PRODUÇÃO (Fictício)",
"item_id": "10081",
"location": "Sao Paulo - Sao Paulo",
"list": "Featured Hotels",
"affiliation": "Omnibees",
"index": 1
},
{
"item_name": "DEMO - BEE2BEE",
"item_id": "10027",
"location": "Sao Paulo - Sao Paulo",
"list": "Featured Hotels",
"affiliation": "Omnibees",
"index": 2
}
]
},
"impressions": [
{
"name": "Niara (Ambiente de Testes) - HOTEL NÃO É PRODUÇÃO (Fictício)",
"id": "10081",
"list": "Featured Hotels",
"position": 1
},
{
"name": "DEMO - BEE2BEE",
"id": "10027",
"list": "Featured Hotels",
"position": 2
}
]
}

2. Pesquisa por destino/cadeia hoteleira

  • Nome do evento: ecommerceChain
  • Acionadores:
    • Quando o usuário faz uma pesquisa por destino (cidade, bairro, Todos os hotéis)
    • Obs: não é disparado quando o usuário faz pesquisa por hotel específico

O objeto ecommerce.items contém um item para cada hotel retornado na listagem. O item_category é Hotel neste evento.

{
"event": "ecommerceChain",
"eventDetails": {
"category": "Ecommerce",
"action": "Cadeia Hoteleira"
},
"versionBE": "otabuilder_v2",
"chainName": "Niara Resorts",
"chainId": "995",
"isRemark": false,
"lang": "pt-BR",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"coupon": "PROMONIARA",
"numberAdults": 2,
"numberChildren": 0,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userTel": null,
"userNationality": null,
"userCountry": null,
"userAddressCountryCode": null,
"userAddressCity": null,
"userAddressComplement": null,
"userAddressDistrict": null,
"userAddressNumber": null,
"userAddressState": null,
"userAddressStreet": null,
"userAddressZipCode": null,
"userDob": null,
"userPassport": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"userVatNumber": null,
"userBrandName": null,
"userCorporateName": null,
"userInscricaoMunicipal": null,
"userInscricaoEstadual": null,
"userDoc": null,
"ecommerce": {
"currency": "BRL",
"items": [
{
"item_id": "10027",
"item_name": "Niara Resorts",
"item_brand": "Niara Resorts",
"item_category": "Hotel",
"coupon": "PROMONIARA",
"price": 623.33,
"quantity": 3,
"index": 0,
"item_list_name": "Hotel List",
"currency": "BRL",
"item_availability": "Available for Sale",
"item_rate_id": 315919,
"location": "Sao Paulo",
"niaraHotelId": "HOTEL_OMNI_10027"
},
{
"item_id": "12866",
"item_name": "Niara Resorts - Praia",
"item_brand": "Niara Resorts",
"item_category": "Hotel",
"coupon": "PROMONIARA",
"price": 850.5,
"quantity": 3,
"index": 1,
"item_list_name": "Hotel List",
"currency": "BRL",
"item_availability": "Available for Sale",
"item_rate_id": 315920,
"location": "Maragogi",
"niaraHotelId": "HOTEL_OMNI_12866"
}
],
"currencyCode": "BRL",
"impressions": [
{
"name": "Niara Resorts",
"id": "10027",
"price": 623.33,
"category": "Hotel",
"brand": "Niara Resorts",
"list": "Hotel List",
"position": 0,
"niaraHotelId": "HOTEL_OMNI_10027"
},
{
"name": "Niara Resorts - Praia",
"id": "12866",
"price": 850.5,
"category": "Hotel",
"brand": "Niara Resorts",
"list": "Hotel List",
"position": 1,
"niaraHotelId": "HOTEL_OMNI_12866"
}
]
},
"niaraChainId": "CHAIN_OMNI_995",
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "São Paulo (Cidade)",
"daysAdvance": 116
}

3. Hotel Details

  • Nome do evento: ecommerceSearch
  • Acionadores:
    • Quando o usuário clica em um hotel a partir da tela de resultado de pesquisa
    • Quando o usuário faz pesquisa de um hotel específico

O objeto ecommerce.items contém um item para cada tarifa disponível no hotel. O item_category é Accommodation.

{
"event": "ecommerceSearch",
"eventDetails": {
"category": "Ecommerce",
"action": "Resultados de Pesquisa"
},
"versionBE": "otabuilder_v2",
"chainName": "Niara Resorts",
"chainId": "995",
"isRemark": false,
"lang": "pt-BR",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"coupon": "PROMONIARA",
"numberAdults": 2,
"numberChildren": 0,
"hotelName": "Niara Resorts",
"hotelId": "10027",
"hotelCategoryId": "",
"hotelCategoryName": "",
"ratingStars": 5,
"numberRooms": 1,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userTel": null,
"userNationality": null,
"userCountry": null,
"userAddressCountryCode": null,
"userAddressCity": null,
"userAddressComplement": null,
"userAddressDistrict": null,
"userAddressNumber": null,
"userAddressState": null,
"userAddressStreet": null,
"userAddressZipCode": null,
"userDob": null,
"userPassport": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"userVatNumber": null,
"userBrandName": null,
"userCorporateName": null,
"userInscricaoMunicipal": null,
"userInscricaoEstadual": null,
"userDoc": null,
"ecommerce": {
"currency": "BRL",
"items": [
{
"item_id": 62718,
"item_name": "Master",
"item_variant": "Tarifa Padrão",
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"affiliation": "Omnibees",
"coupon": "PROMONIARA",
"price": 590.35,
"discount": 368.96,
"quantity": 3,
"index": 0,
"item_list_name": "Search Results",
"currency": "BRL",
"item_availability": "Available for Sale",
"item_rate_id": 315919,
"location": "Sao Paulo"
},
{
"item_id": 89772,
"item_name": "Superior",
"item_variant": "Tarifa Padrão",
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"affiliation": "Omnibees",
"coupon": "PROMONIARA",
"price": 268.83,
"discount": 400.79,
"quantity": 3,
"index": 1,
"item_list_name": "Search Results",
"currency": "BRL",
"item_availability": "Available for Sale",
"item_rate_id": 315919,
"location": "Sao Paulo"
}
],
"currencyCode": "BRL",
"impressions": [
{
"name": "Master",
"id": 62718,
"price": 1771.04,
"category": "Accommodation",
"brand": "Niara Resorts",
"list": "Search Results",
"position": 0
},
{
"name": "Superior",
"id": 89772,
"price": 806.49,
"category": "Accommodation",
"brand": "Niara Resorts",
"list": "Search Results",
"position": 1
}
]
},
"niaraHotelId": "HOTEL_OMNI_10027",
"niaraChainId": "CHAIN_OMNI_995",
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "Sao Paulo",
"daysAdvance": 116
}

4. Add to Cart

  • Nome do evento: ecommerceAddToCart
  • Acionadores:
    • Quando o usuário adiciona um quarto ao carrinho (item_category: "Accommodation")
    • Quando o usuário adiciona uma experiência ao carrinho (item_category: "EXTRA")

O evento é disparado uma vez por item adicionado.

Exemplo — Acomodação

{
"event": "ecommerceAddToCart",
"hotelId": "10027",
"hotelName": "Niara Resorts",
"chainId": "995",
"chainName": "Niara Resorts",
"isRemark": false,
"lang": "pt-BR",
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userTel": null,
"userNationality": null,
"userCountry": null,
"userAddressCountryCode": null,
"userAddressCity": null,
"userAddressComplement": null,
"userAddressDistrict": null,
"userAddressNumber": null,
"userAddressState": null,
"userAddressStreet": null,
"userAddressZipCode": null,
"userDob": null,
"userPassport": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"userVatNumber": null,
"userBrandName": null,
"userCorporateName": null,
"userInscricaoMunicipal": null,
"userInscricaoEstadual": null,
"userDoc": null,
"ecommerce": {
"currency": "BRL",
"currencyCode": "BRL",
"value": 1771.04,
"items": [
{
"item_id": 62718,
"item_name": "Master",
"item_variant": "Tarifa Padrão",
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"affiliation": "Omnibees",
"coupon": "PROMONIARA",
"price": 590.35,
"discount": 368.96,
"quantity": 3,
"item_list_id": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"item_category2": 5,
"item_category3": "",
"currency": "BRL",
"check_in": "20260810",
"check_out": "20260813"
}
]
},
"niaraHotelId": "HOTEL_OMNI_10027",
"niaraChainId": "HOTEL_OMNI_10027",
"location": "Sao Paulo"
}

Exemplo — Experiência (EXTRA)

O item_id é o ID da experiência. O item_category é EXTRA.

{
"event": "ecommerceAddToCart",
"hotelId": "10027",
"hotelName": "Niara Resorts",
"chainId": "995",
"lang": "pt-BR",
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userTel": null,
"userNationality": null,
"userCountry": null,
"userAddressCountryCode": null,
"userAddressCity": null,
"userAddressComplement": null,
"userAddressDistrict": null,
"userAddressNumber": null,
"userAddressState": null,
"userAddressStreet": null,
"userAddressZipCode": null,
"userDob": null,
"userPassport": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"userVatNumber": null,
"userBrandName": null,
"userCorporateName": null,
"userInscricaoMunicipal": null,
"userInscricaoEstadual": null,
"userDoc": null,
"ecommerce": {
"currency": "BRL",
"currencyCode": "BRL",
"value": 95,
"items": [
{
"item_id": "c294a350-a6a1-4aca-ac23-9126a0361606",
"item_name": "Bolo",
"item_variant": "Grande (1kg)",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"affiliation": "Omnibees",
"price": 95,
"quantity": 1,
"currency": "BRL",
"check_in": "20260810",
"check_out": "20260813"
}
]
},
"niaraHotelId": "HOTEL_OMNI_10027",
"niaraChainId": "CHAIN_OMNI_995",
"location": "Sao Paulo"
}

5. Remove from Cart

  • Nome do evento: ecommerceRemoveFromCart
  • Acionadores:
    • Quando o usuário remove um quarto do carrinho (item_category: "Accommodation")
    • Quando o usuário remove uma experiência do carrinho (item_category: "EXTRA")

Exemplo — Acomodação

{
"event": "ecommerceRemoveFromCart",
"hotelId": "10027",
"hotelName": "Niara Resorts",
"chainId": "995",
"chainName": "Niara Resorts",
"isRemark": false,
"lang": "pt-BR",
"ecommerce": {
"currency": "BRL",
"currencyCode": "BRL",
"value": 1771.04,
"items": [
{
"affiliation": "Omnibees",
"coupon": "PROMONIARA",
"discount": 368.96,
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"item_id": 62718,
"item_name": "Master",
"item_variant": "Tarifa Padrão",
"price": 590.35,
"quantity": 3,
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"item_category3": "",
"currency": "BRL"
}
]
},
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"niaraHotelId": "HOTEL_OMNI_10027",
"niaraChainId": "CHAIN_OMNI_995",
"location": "Sao Paulo"
}

Exemplo — Experiência (EXTRA)

{
"event": "ecommerceRemoveFromCart",
"hotelId": "10027",
"hotelName": "Niara Resorts",
"chainId": "995",
"lang": "pt-BR",
"ecommerce": {
"currency": "BRL",
"currencyCode": "BRL",
"value": 38,
"items": [
{
"item_id": "be5d5eb1-5e63-45b7-adf2-d2140ead3714",
"item_name": "Buquê de Rosas",
"item_variant": null,
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"affiliation": "Omnibees",
"price": 38,
"quantity": 1,
"currency": "BRL",
"check_in": "20260810",
"check_out": "20260813"
}
]
},
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"niaraHotelId": "HOTEL_OMNI_10027",
"niaraChainId": "CHAIN_OMNI_995",
"location": "Sao Paulo"
}

6. Início do checkout (dados pessoais)

  • Nome do evento: ecommerceCheckout
  • Acionadores:
    • Quando o usuário acessa a tela de checkout (passo de dados pessoais)

O campo eventDetails.label indica o passo: "Passo 1 - Dados Pessoais". O ecommerce.items inclui tanto a acomodação (Accommodation) quanto todas as experiências (EXTRA) no carrinho.

{
"event": "ecommerceCheckout",
"eventDetails": {
"category": "Ecommerce",
"action": "Checkout",
"label": "Passo 1 - Dados Pessoais"
},
"versionBE": "otabuilder_v2",
"chainName": "Niara Resorts",
"chainId": "995",
"hotelName": "Niara Resorts",
"hotelId": "10027",
"checkIn": "20260810",
"checkOut": "20260813",
"coupon": "PROMONIARA",
"hotelCategoryName": null,
"hotelCategoryId": null,
"ratingStars": 5,
"numberRooms": 1,
"numberAdults": 2,
"numberChildren": 0,
"isLoggedIn": null,
"lang": "pt-BR",
"isRemark": false,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userTel": null,
"userNationality": null,
"userCountry": null,
"userAddressCountryCode": null,
"userAddressCity": null,
"userAddressComplement": null,
"userAddressDistrict": null,
"userAddressNumber": null,
"userAddressState": null,
"userAddressStreet": null,
"userAddressZipCode": null,
"userDob": null,
"userPassport": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"userVatNumber": null,
"userBrandName": null,
"userCorporateName": null,
"userInscricaoMunicipal": null,
"userInscricaoEstadual": null,
"userDoc": null,
"ecommerce": {
"currency": "BRL",
"value": 2260.39,
"items": [
{
"affiliation": "Omnibees",
"discount": 368.96,
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"item_id": 62718,
"item_name": "Master",
"item_variant": "Tarifa Padrão",
"coupon": "PROMONIARA",
"price": 590.35,
"quantity": 3,
"index": 0,
"currency": "BRL",
"item_list_id": "995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"item_category2": 5,
"item_category3": "hotel",
"location": "Sao Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "cf45ef2b-9c85-4c7f-be8a-e0d4d97af78e",
"item_name": "Ingresso Parque",
"item_variant": "Adulto",
"price": 0,
"quantity": 1,
"index": 0,
"currency": "BRL",
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"location": "Sao Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "c294a350-a6a1-4aca-ac23-9126a0361606",
"item_name": "Bolo",
"item_variant": "Grande (1kg)",
"price": 95,
"quantity": 1,
"index": 2,
"currency": "BRL",
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"location": "Sao Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "536932f4-2c0c-4cff-889e-b384016902aa",
"item_name": "Estacionamento",
"item_variant": null,
"price": 285,
"quantity": 1,
"index": 3,
"currency": "BRL",
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"location": "Sao Paulo"
}
],
"currencyCode": "BRL",
"checkout": {
"actionField": {
"step": 1
},
"products": [
{
"name": "Master",
"id": 62718,
"price": 590.35,
"brand": "Niara Resorts",
"category": "Accommodation",
"quantity": 3,
"dimension4": "Tarifa Padrão",
"dimension5": 2
}
],
"guestData": {
"email": "hospede@email.com",
"name": "Josivaldo Santos",
"phone": null
}
}
},
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "Sao Paulo",
"niaraChainId": "CHAIN_OMNI_995",
"niaraHotelId": "HOTEL_OMNI_10027",
"check_in": "20260810",
"check_out": "20260813",
"daysAdvance": 116
}

7. Dados de pagamento

  • Nome do evento: ecommerceCheckout
  • Acionadores:
    • Quando o usuário acessa a tela de pagamento (passo de informações de pagamento)

O campo eventDetails.label indica o passo: "Passo 2 - Pagamento". A estrutura de ecommerce.items é idêntica ao passo 1, incluindo acomodações e experiências. O campo ecommerce.payment_type está vazio neste passo e ecommerce.payments ainda não está presente — o usuário ainda não confirmou a forma de pagamento.

{
"event": "ecommerceCheckout",
"versionBE": "otabuilder_v2",
"eventDetails": {
"category": "Ecommerce",
"action": "Checkout",
"label": "Passo 2 - Pagamento"
},
"hotelName": "Niara Resorts",
"hotelId": "10027",
"chainName": "Niara Resorts",
"chainId": "995",
"hotelCategoryName": null,
"hotelCategoryId": null,
"ratingStars": 5,
"numberRooms": 1,
"checkIn": "20260810",
"checkOut": "20260813",
"numberAdults": 2,
"numberChildren": 0,
"lang": "pt-BR",
"coupon": "PROMONIARA",
"isRemark": false,
"isLoggedIn": null,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userTel": null,
"userNationality": null,
"userCountry": null,
"userAddressCountryCode": null,
"userAddressCity": null,
"userAddressComplement": null,
"userAddressDistrict": null,
"userAddressNumber": null,
"userAddressState": null,
"userAddressStreet": null,
"userAddressZipCode": null,
"userDob": null,
"userPassport": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"userVatNumber": null,
"userBrandName": null,
"userCorporateName": null,
"userInscricaoMunicipal": null,
"userInscricaoEstadual": null,
"userDoc": null,
"ecommerce": {
"currency": "BRL",
"value": 2260.39,
"payment_type": "",
"items": [
{
"affiliation": "Omnibees",
"discount": 368.96,
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"item_id": 62718,
"item_name": "Master",
"item_variant": "Tarifa Padrão",
"coupon": "PROMONIARA",
"price": 590.35,
"quantity": 3,
"index": 0,
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"item_category3": "",
"location": "Sao Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "c294a350-a6a1-4aca-ac23-9126a0361606",
"item_name": "Bolo",
"item_variant": "Grande (1kg)",
"price": 95,
"quantity": 1,
"index": 1,
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"location": "Sao Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "536932f4-2c0c-4cff-889e-b384016902aa",
"item_name": "Estacionamento",
"item_variant": null,
"price": 285,
"quantity": 1,
"index": 2,
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"location": "Sao Paulo"
}
],
"currencyCode": "BRL",
"checkout": {
"actionField": {
"step": 2
},
"products": [
{
"name": "Master",
"id": 62718,
"price": 590.35,
"brand": "Niara Resorts",
"category": "Accommodation",
"quantity": 3,
"dimension4": "Tarifa Padrão",
"dimension5": 2
}
],
"guestData": {
"email": "hospede@email.com",
"name": "Josivaldo Santos",
"phone": null
}
}
},
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "Sao Paulo",
"niaraChainId": "995",
"niaraHotelId": "10027",
"check_in": "20260810",
"check_out": "20260813",
"daysAdvance": 116
}

8. Reservar

Ocorre quando o cliente clica em confirmar reserva, iniciando o processamento do pagamento e da reserva. Para reservas com cartão, esse evento ocorre após o cliente preencher os dados do cartão. No caso de PIX, este evento ocorre antes da exibição do código QR Code.

O campo eventDetails.label indica o passo: "Passo 3 - Clique - Confirmar Reserva". É neste passo que ecommerce.payment_type é preenchido com as formas de pagamento escolhidas, separados por / quando há mais de uma (ex: "Cartão de crédito", "Cartão de crédito / POINTS", "Cartão de crédito / Pix"). O campo ecommerce.payments lista o detalhamento de cada pagamento com type, value e currency.

{
"event": "ecommerceCheckout",
"versionBE": "otabuilder_v2",
"eventDetails": {
"category": "Ecommerce",
"action": "Checkout",
"label": "Passo 3 - Clique - Confirmar Reserva"
},
"hotelName": "Niara Resorts",
"hotelId": "10027",
"chainId": "995",
"chainName": "Niara Resorts",
"hotelCategoryName": null,
"hotelCategoryId": null,
"ratingStars": 5,
"numberRooms": 1,
"checkIn": "20260810",
"checkOut": "20260813",
"numberAdults": 2,
"numberChildren": 0,
"lang": "pt-BR",
"coupon": "PROMONIARA",
"isRemark": false,
"isLoggedIn": null,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userTel": null,
"userNationality": null,
"userCountry": null,
"userAddressCountryCode": null,
"userAddressCity": null,
"userAddressComplement": null,
"userAddressDistrict": null,
"userAddressNumber": null,
"userAddressState": null,
"userAddressStreet": null,
"userAddressZipCode": null,
"userDob": null,
"userPassport": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"userVatNumber": null,
"userBrandName": null,
"userCorporateName": null,
"userInscricaoMunicipal": null,
"userInscricaoEstadual": null,
"userDoc": null,
"ecommerce": {
"payment_type": "Cartão de crédito",
"payments": [{ "type": "Cartão de crédito", "value": 2260.39, "currency": "BRL" }],
"currency": "BRL",
"value": 2260.39,
"coupon": "PROMONIARA",
"items": [
{
"affiliation": "Omnibees",
"discount": 270,
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"item_id": 62718,
"item_name": "Master",
"item_variant": "Tarifa Padrão",
"coupon": "PROMONIARA",
"price": 590.35,
"quantity": 3,
"index": 0,
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"item_category3": "hotel",
"location": "Sao Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "536932f4-2c0c-4cff-889e-b384016902aa",
"item_name": "Estacionamento",
"item_variant": null,
"price": 285,
"quantity": 1,
"index": 1,
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"item_category3": null,
"location": "Sao Paulo"
}
],
"currencyCode": "BRL",
"checkout": {
"actionField": {
"step": 3,
"option": "Cartão de crédito"
},
"products": [
{
"name": "Master",
"id": 62718,
"price": 590.35,
"brand": "Niara Resorts",
"category": "Accommodation",
"quantity": 3,
"dimension4": "Tarifa Padrão",
"dimension5": 2
}
],
"guestData": {
"email": "hospede@email.com",
"name": "Josivaldo Santos",
"phone": null
}
}
},
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "Sao Paulo",
"niaraHotelId": "HOTEL_OMNI_10027",
"niaraChainId": "CHAIN_OMNI_995",
"check_in": "20260810",
"check_out": "20260813",
"daysAdvance": 116
}

9. Purchase

Ocorre após a confirmação da reserva.

note

A ordem da confirmação da reserva e a confirmação do pagamento (PIX ou cartão de crédito) depende da configuração do Motor.

O ecommerce.transaction_id contém o ID da reserva gerada (ex: RES064384-10027). O item_id da acomodação também usa esse ID. Experiências (EXTRA) aparecem junto com a acomodação em ecommerce.items.

{
"event": "ecommercePurchase",
"versionBE": "otabuilder_v2",
"eventDetails": {
"category": "Ecommerce",
"action": "Purchase"
},
"chainName": "Niara Resorts",
"chainId": "995",
"checkIn": "20260810",
"checkOut": "20260813",
"coupon": "PROMONIARA",
"hotelCategoryId": null,
"hotelCategoryName": null,
"hotelId": "10027",
"hotelName": "Niara Resorts",
"isRemark": false,
"isLoggedIn": null,
"lang": "pt-BR",
"numberAdults": 2,
"numberChildren": 0,
"numberRooms": 1,
"ratingStars": 5,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userId": null,
"dimension1": null,
"userAddressCountryCode": null,
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"userRg": null,
"userRgOrgaoEmissor": null,
"ecommerce": {
"value": 1979.35,
"payment_type": "CREDITCARD",
"payments": [{ "type": "CREDITCARD", "value": 1979.35, "currency": "BRL" }],
"transaction_id": "RES064384-10027",
"tax": 109.35,
"currency": "BRL",
"currencyCode": "BRL",
"items": [
{
"affiliation": "Omnibees",
"coupon": "PROMONIARA",
"currency": "BRL",
"discount": 270,
"item_brand": "Niara Resorts",
"item_category": "Accommodation",
"item_id": "RES064384-10027",
"item_name": "Master",
"item_variant": "Tarifa Padrão",
"price": 623.33,
"quantity": 3,
"index": 0,
"location": "São Paulo",
"item_category2": 5,
"item_category3": null,
"item_list_id": "995",
"niaraChainId": "CHAIN_OMNI_995",
"item_list_name": "Niara Resorts",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "536932f4-2c0c-4cff-889e-b384016902aa",
"item_name": "Estacionamento",
"item_variant": null,
"price": 300,
"quantity": 1,
"index": 0,
"currency": "BRL",
"item_list_id": "995",
"item_list_name": "Niara Resorts",
"niaraChainId": "CHAIN_OMNI_995",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"item_category3": null,
"location": "São Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "cf45ef2b-9c85-4c7f-be8a-e0d4d97af78e",
"item_name": "Ingresso Parque",
"item_variant": "Adulto",
"price": 530,
"quantity": 1,
"index": 1,
"currency": "BRL",
"item_list_id": "995",
"item_list_name": "Niara Resorts",
"niaraChainId": "CHAIN_OMNI_995",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"item_category3": null,
"location": "São Paulo"
},
{
"affiliation": "Omnibees",
"item_brand": "Niara Resorts",
"item_category": "EXTRA",
"item_id": "c294a350-a6a1-4aca-ac23-9126a0361606",
"item_name": "Bolo",
"item_variant": "Grande (1kg)",
"price": 100,
"quantity": 1,
"index": 2,
"currency": "BRL",
"item_list_id": "995",
"item_list_name": "Niara Resorts",
"niaraChainId": "CHAIN_OMNI_995",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"item_category2": 5,
"item_category3": null,
"location": "São Paulo"
}
],
"purchase": {
"actionField": {
"id": "RES064384-10027",
"revenue": 1979.35,
"tax": 109.35,
"shipping": "0",
"affiliation": "",
"coupon": "PROMONIARA",
"currency": "BRL"
},
"products": [
{
"name": "Master",
"id": "62718",
"price": 623.33,
"category": "Accommodation",
"brand": "Niara Resorts",
"quantity": 3,
"dimension4": "Tarifa Padrão",
"dimension5": 2,
"currency": "BRL"
}
]
}
},
"check_in": "20260810",
"check_out": "20260813",
"niaraChainId": "CHAIN_OMNI_995",
"niaraHotelId": "HOTEL_OMNI_10027",
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "São Paulo",
"daysAdvance": 116
}

10. Sem resultados

  • Nome do evento: ecommerceNoResults
  • Acionadores:
    • Quando uma pesquisa (por destino ou por hotel específico) não retorna nenhum quarto disponível

O objeto ecommerce.items vem sempre vazio ([]) neste evento — ele não representa produtos, apenas o contexto da busca sem resultado.

O campo reason traz o(s) motivo(s) da indisponibilidade:

  • Quando o hotel retornou tarifas mas todas indisponíveis por restrição, reason é um array com um item por restrição única (code + description), com status: "NOT_AVAILABLE".
  • Quando não há detalhamento de restrição (ex: busca por destino sem nenhum hotel disponível), reason traz um item único genérico com status e code iguais a "NO_RESULTS".

O campo deviceType ("mobile" ou "desktop") é omitido quando a informação de dispositivo não está disponível no ponto de disparo do evento.

O campo location usa a cidade do hotel quando disponível; caso contrário, cai para o destino pesquisado.

Exemplo — restrição de disponibilidade (hotel específico)

{
"event": "ecommerceNoResults",
"eventDetails": {
"category": "Ecommerce",
"action": "No Search Results"
},
"hotelId": "10027",
"hotelName": "Niara Resorts",
"chainId": "995",
"chainName": "Niara Resorts",
"hotelCategoryId": null,
"hotelCategoryName": null,
"ratingStars": 5,
"numberRooms": 1,
"roomsRequested": 1,
"versionBE": "otabuilder_v2",
"isRemark": false,
"lang": "pt-BR",
"currency": null,
"deviceType": "mobile",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"losNights": 3,
"numberAdults": 2,
"numberChildren": 0,
"childrenAges": [],
"coupon": "PROMONIARA",
"searchScope": null,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"reason": [
{
"code": "411",
"description": "Duração mínima da estadia não atingida",
"status": "NOT_AVAILABLE"
},
{
"code": "397",
"description": "Quantidade de hóspedes inválida",
"status": "NOT_AVAILABLE"
}
],
"ecommerce": {
"currency": null,
"items": [],
"currencyCode": null,
"impressions": []
},
"niaraChainId": "CHAIN_OMNI_995",
"niaraHotelId": "HOTEL_OMNI_10027",
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "Sao Paulo",
"daysAdvance": 116
}

Exemplo — busca por destino sem hotéis disponíveis

{
"event": "ecommerceNoResults",
"eventDetails": {
"category": "Ecommerce",
"action": "No Search Results"
},
"hotelId": null,
"hotelName": null,
"chainId": null,
"chainName": null,
"hotelCategoryId": null,
"hotelCategoryName": null,
"ratingStars": null,
"numberRooms": 1,
"roomsRequested": 1,
"versionBE": "otabuilder_v2",
"isRemark": false,
"lang": "pt-BR",
"currency": null,
"deviceType": "desktop",
"check_in": "20260810",
"check_out": "20260813",
"checkIn": "20260810",
"checkOut": "20260813",
"losNights": 3,
"numberAdults": 2,
"numberChildren": 0,
"childrenAges": [],
"coupon": null,
"searchScope": null,
"firstName": "Josivaldo",
"lastName": "Santos",
"userEmail": "hospede@email.com",
"userPersonId": "1df35a5e-3ba2-437c-b981-bef87fc06c3b",
"reason": [
{
"status": "NO_RESULTS",
"code": "NO_RESULTS",
"description": "Não encontrou resultados para o critério de busca."
}
],
"ecommerce": {
"currency": null,
"items": [],
"currencyCode": null,
"impressions": []
},
"niaraChainId": null,
"niaraHotelId": null,
"clientName": "Niara Resorts",
"clientProject": "LZcD2nT8PnbUEzPG5cB24",
"location": "São Paulo (Cidade)",
"daysAdvance": 116
}

11. Login

  • Nome do evento: login
  • Acionadores:
    • Quando uma pessoa realiza login no Motor Niara, seja via login por código, usuário e senha ou via provedor de identidade

O campo method diz o meio que o usuário escolheu para se autenticar, sendo possível ter os valores CODE (login por código), OAUTH2 (provedor de identidade, como a Google), USER_PASSWORD (alguma integração por usuário e senha que não seja Niara Account) ou NIARA_ACCOUNT (login via Niara Account).

Exemplo — Login após pesquisa previamente realizada

{
"event": "login",
"chainName": "DEMO HOTEIS BRASIL",
"chainId": "995",
"hotelName": "DEMO - BEE2BEE (NIARA)",
"hotelId": "10027",
"versionBE": "otabuilder_v1",
"isRemark": false,
"lang": "pt-BR",
"method": "OAUTH2"
}

Exemplo — Login na página Home

{
"event": "login",
"chainName": null,
"chainId": null,
"hotelName": null,
"hotelId": null,
"versionBE": "otabuilder_v1",
"isRemark": false,
"lang": "pt-BR",
"method": "CODE"
}

12. Cadastro

  • Nome do evento: sing_up
  • Acionadores:
    • Quando uma pessoa registra-se em um motor niara via formulário interno da aplicação.

O campo method diz o meio que o usuário escolheu para se cadastrar, suportando hoje o método NIARA_ACCOUNT.

Exemplo — Cadastro após pesquisa previamente realizada

{
"event": "sing_up",
"chainName": "DEMO HOTEIS BRASIL",
"chainId": "995",
"hotelName": "DEMO - BEE2BEE (NIARA)",
"hotelId": "10027",
"versionBE": "otabuilder_v1",
"isRemark": false,
"lang": "pt-BR",
"method": "NIARA_ACCOUNT"
}

Exemplo — Cadastro na página Home

{
"event": "sing_up",
"chainName": null,
"chainId": null,
"hotelName": null,
"hotelId": null,
"versionBE": "otabuilder_v1",
"isRemark": false,
"lang": "pt-BR",
"method": "NIARA_ACCOUNT"
}

13. Error

  • Nome do evento: exception
  • Acionadores:
    • Quando ocorre algum erro durante o processo da reserva, seja no checkout, na confirmação de seu pagamento ou no processamento da reserva.

No campo eventDetails é enviada a mensagem de erro em description e o passo em que ocorreu o erro em step. O campo fatal indica se o erro é fatal ou não.

Exemplo - Erro ao processar pagamento

{
"event": "exception",
"clientName": "Dev Andre",
"clientProject": "LTmD8zY8NmnOizPB2c8R0",
"location": "",
"versionBE": "otabuilder_v1",
"hotelId": "10081",
"hotelName": "Niara (Ambiente de Testes) - HOTEL NÃO É PRODUÇÃO (Fictício)",
"chainId": "995",
"chainName": "DEMO HOTEIS BRASIL",
"isRemark": false,
"eventDetails": {
"id": "FAILED",
"category": "Ecommerce",
"step": "SuccessPage",
"description": "ConnectionWithAcquirerFailed",
"fatal": false
}
}