Dados da loja

Utilizado para carregar os dados da loja que está sendo acessada. Sua propriedade é:

model traz o registro da loja

Banners

Carrega o(s) banners a partir do(s) ID(s) informado(s)

É utilizado para a exibição de banners cadastrados a partir da informação de seu ID. Suas propriedades são:
collection, traz a coleção de banners.

Seu parâmetro que pode ser utilizado é:

id, do tipo int para informar o id dos banners a serem carregados.
sorts, do tipo string, para informar o campo extra de ordenação dos banners a serem carregados
sortsDirections, do tipo string, para informar a direção da ordenação dos banners a serem carregados. Preencher com asc ou desc.

Carrega banners tagueados pelas tags com o(s) ID(s) informado(s)

É utilizado para a exibição de banners cadastrados a partir de suas tags e informação de seu ID. Suas propriedades são:
collection, traz a coleção de banners.
tags, traz a coleção de tags

Seus parâmetros que podem ser utilizados são:
id e limit, ambos do tipo int, para indicar quais os ids de tags e limite de banners devem ser carregados, respectivamente.
sorts, do tipo string, para informar o campo extra de ordenação dos banners a serem carregados
sortsDirections, do tipo string, para informar a direção da ordenação dos banners a serem carregados. Preencher com asc ou desc.

Busca/Filtragem

Resultado da busca

Fornece uma listagem com os produtos com alguma promoção aplicada

Data provider de vitrine utilizado para trazer uma lista com os itens que tem alguma promoção cadastrada no ERP. Suas propriedades são:
collection, traz a coleção de itens com promoção.
priceMin, traz o preço mínimo dos itens com promoção.
priceMax, traz o preço máximo dos itens com promoção.
currentPriceMin , traz o preço mínimo atual dos itens com promoção.
currentPriceMax , traz o preço máximo atual dos itens com promoção.
metadata , traz as informações dos dados dos itens com promoção.
tags , traz uma coleção de tags dos itens com promoção.
extraFields , traz os campos extras dos itens com promoção.

Os parâmetros que podem ser utilizados são:
sorts e  sortsDirections ambos do tipo  string .
limit , do tipo int . 

Categoria

Listagem de categorias

É utilizado para a exibição da listagem de todas as categorias, um exemplo de utilização, seria no menu principal de categoria. Suas propriedades são:
collection, traz a coleção de todas categorias cadastradas.

Os parâmetros que podem ser utilizados são:
sorts para determinar qual a ordenação padrão da listagem. Pode ser informado um slug de campo extra.
sortsDirections para determinar qual a direção da ordenação (crescente ou descendente). Pode ser asc ou desc.

Carrega a categoria pela URL solicitada e os produtos associados à ela

Data provider de vitrine utilizado para a exibição da listagem de itens relacionados à categoria com a URL informada. Suas propriedades são:
collection, traz a coleção de itens relacionados a categoria.
model, carrega a instância da categoria.
priceMin, traz o preço mínimo dos itens determinada categoria.
priceMax, traz o preço máximo dos itens determinada categoria.
currentPriceMin , traz o preço mínimo atual dos itens determinada categoria.
currentPriceMax , traz o preço máximo atual dos itens determinada categoria.
metadata , traz as informações dos dados dos itens determinada categoria.
tags , traz uma coleção de tags dos itens determinada categoria.
extraFields , traz os campos extras de uma determinada categoria.

Os parâmetros que podem ser utilizados são:
sorts para determinar qual a ordenação padrão da listagem. Pode ser um slug de campo extra ou algum dos campos filtráveis da vitrine
sortsDirections para determinar qual a direção da ordenação (crescente ou descendente). Pode ser asc ou desc.

componentizationGroupsSorts define a ordenação dos grupos de componentes de cada item. Preencher com os nomes exatos dos grupos de componentes na sequência desejada.

Carrega categorias tagueados pelas tags com o(s) ID(s) informado(s)

Checkout/Usuário

Fornece os dados do carrinho

É utilizado para a exibição de dados pertencentes ao carrinho, como produtos, preço e quantidade. Suas propriedades são:
collection , traz a coleção de produtos adicionados no carrinho.
count , traz a quantidade de produtos adicionados no carrinho.
subtotal , traz o subtotal do da soma dos valores dos produtos adicionados no carrinho.
total , traz o total da soma dos valores dos produtos adicionados no carrinho.

Fornece uma instância de Cliente a partir do usuário logado

É utilizado para instanciar um usuário quando logado. Suas propriedades são:
model, que instancia o cliente.

Entidade Virtual

Disponibiliza todos os registros de uma entidade virtual e os itens associados a cada um deles

Seus parâmetros são:
virtualEntiyld, do tipo int, que é o ID da entidade virtual dos registros a serem retornados.
virtualEntityRecordsLimit, do tipo int, que é o limite dos registros da entidade virtual.
sorts para determinar qual a ordenação padrão da listagem. Deve ser informado um slug de campo extra.
sortsDirections para determinar qual a direção da ordenação (crescente ou descendente). Pode ser asc ou desc.

Suas propriedades são:

records que retorna a coleção com registros da entidade virtual.

Carrega um registro de entidade virtual e os itens associados a cada um deles

Seu parâmetro que pode ser utilizado é:
virtualEntityId , do tipo int .

Disponibiliza todos os registros de uma entidade virtual tagueados

Seus parâmetros que podem ser utilizados são:
virtualEntityId do tipo int que é o id da entidade virtual cujos registros devem ser carregados.
id do tipo int que é o id da tag que deve filtrar os registros da entidade virtual a serem carregados.

Disponibiliza todos os registros de uma entidade virtual pelos IDs

Seus parâmetros são:
virtualEntityId do tipo int que é o id da entidade virtual cujos registros devem ser carregados.
ids do tipo int que são os ids dos registros que devem ser carregados. Esses registros devem pertencer a entidade virtual informada no parâmetro virtualEntityId.

Suas propriedades são:

records que retorna a coleção com registros da entidade virtual.

Carrega as formas de pagamento disponíveis para o e-commerce e suas opções de parcelamento pelos IDs informados

É utilizado para exibir as formas de pagamento cadastradas no e-commerce, e suas respectivas quantidades de parcelamentos permitidas, também cadastradas previamente. Suas propriedades são:
collection, traz a coleção de PaymentMethod, ou seja, formas de pagamento.

Itens/Planos

Carrega os itens adicionados recentemente, onde a data de criação é maior do que a data limite informada

Data provider de vitrine utilizado para a exibição dos itens cadastrados recentemente na plataforma. Um exemplo de utilização são para a listagem de lançamentos. Suas propriedades são:
collection, traz a coleção dos itens recentes.
model, que instancia os itens recentes.
priceMin, traz o preço mínimo de itens recentes.
priceMax, traz o preço máximo de itens recentes.
currentPriceMin , traz o preço mínimo atual de itens recentes.
currentPriceMax , traz o preço máximo atual de itens recentes.
metadata , traz as informações dos dados de itens recentes.
tags , traz uma coleção de tags de itens recentes.
extraFields , traz os campos extras de itens recentes.

Os parâmetros que podem ser utilizados são:
from, do tipo string no formato Y-m-d H:i:s.
limit, do tipo int.
componentizationGroupsSorts define a ordenação dos grupos de componentes de cada item. Preencher com os nomes exatos dos grupos de componentes na sequência desejada.

Carrega o(s) itens a partir do(s) ID(s) informado(s)

Carrega dados do item relacionado à URL acessada

É utilizado para carregar o item relacionado à URL acessada no navegador, normalmente utilizada para página de produto. Suas propriedades são:
model, que instancia um Item.
identification , que instancia o ItemIdentification.
inventory , que instancia o ItemInventory.
price , traz uma coleção de ItemPrice, ou seja, o preço do item.
images , traz uma coleção de ItemImage, ou seja, as imagens cadastradas item.
categories , traz uma coleção de Category.
extraFields , traz uma coleção de campos extra do item.
tags , traz uma coleção de tags do item.
comments , traz uma coleção de comentários do item.
totalCommentCount , traz uma coleção do total de comentários no item.
averageRate , carrega a média das avaliações do item.
fiveStarsCommentsPercentage , carrega a porcentagem de avaliação 5 no item.
fourStarsCommentsPercentage , carrega a porcentagem de avaliação 4 no item.
threeStarsCommentsPercentage , carrega a porcentagem de avaliação 3 no item.
twoStarsCommentsPercentage , carrega a porcentagem de avaliação 2 no item.
oneStarCommentsPercentage , carrega a porcentagem de avaliação 1 no item.
zeroStarCommentsPercentage ,  carrega a porcentagem de avaliação 0 no item.

Os parâmetros que poder ser informados são:

commentsLimit para determinar o limite dos comentários que serão carregados na propriedades comments.

mustConsiderChannels para determinar se a plataforma deverá considerar os canais do produto ao buscá-lo. O valor deverá ser um booleano (1 ou 0) e, se não informado, a plataforma assumirá o valor 0. Em caso positivo, a plataforma carregará o produto relacionado à URL somente se ele estiver relacionado ao canal da loja e, caso não esteja, retornada como não encontrado.

componentizationGroupsSorts define a ordenação dos grupos de componentes de cada item. Preencher com os nomes exatos dos grupos de componentes na sequência desejada.

Carrega o(s) planos a partir do(s) ID(s) informado(s)

É utilizado para trazer uma lista com os planos cadastrados previamente no ERP. Seus parâmetros são:
collection, traz uma coleção de planos.

Os parâmetros que podem ser utilizados são: 
id , do tipo int . 

Carrega itens tagueados pelas tags com o(s) ID(s) informado(s)

Data provider de vitrine utilizado para trazer uma listagens de itens tagueados pelas tags com os IDs informados no parâmetro. Suas propriedades são: 
collection, traz uma coleção de itens.
priceMin, traz o preço mínimo dos itens da busca filtrada, normalmente utilizada para filtragem.
priceMax, traz o preço máximo dos itens da busca filtrada, normalmente utilizada para filtragem.
currentPriceMin , traz o preço mínimo atual dos itens da busca filtrada, normalmente utilizada para filtragem.
currentPriceMax, traz o preço máximo atual dos itens da busca filtrada, normalmente utilizada para filtragem. 
extraFields, traz uma coleção de campos extra dos itens da busca filtrada.
tags, traz uma coleção de tags dos itens da busca filtrada.

E os parâmetros esperados são:

id que indica para a plataforma qual o ID da tag que deve conter os itens
sorts que indica para a plataforma qual a ordenação que os itens devem adotar dentro da coleção. Geralmente um campo extra é criado com esse intuito, nesse caso informar o slug do campo extra.
sortDirections que indica para a plataforma qual a direção da ordenação, se ascendente ou descendente. Utilizar asc ou desc.
limit que indica quantos itens deverão ser retornados na coleção, ou seja, se for uma vitrine de 4 itens porém existirem 20 tagueados, o valor informado para esse parâmetro deverá ser 4.
componentizationGroupsSorts define a ordenação dos grupos de componentes de cada item. Preencher com os nomes exatos dos grupos de componentes na sequência desejada.

Carrega o(s) planos a partir das tags com ID(s) informado(s)

Data provider para trazer uma coleção de planos tagueados pelas tags com os IDs informados no parâmetro.
Sua propriedade é:

collection que representa a coleção de planos tagueados.

Seus parâmetros são:

id que indica para a plataforma quais os IDs das tags que os planos foram tagueados.
sorts que indica para a plataforma qual a ordenação que os planos devem adotar dentro da coleção. Geralmente um campo extra é criado com esse intuito, nesse caso informar o slug do campo extra.
sortDirections que indica para a plataforma qual a direção da ordenação, se ascendente ou descendente. Utilizar asc ou desc.
limit que indica quantos planos deverão ser retornados na coleção, ou seja, se for uma vitrine de 4 planos porém existirem 20 tagueados, o valor informado para esse parâmetro deverá ser 4. Este parâmetro não deverá ser maior do que 24.

Páginas Institucionais

Carrega dados da página institucional relacionada à URL acessada

Carrega as páginas institucionais disponíveis pelos IDs informados

É utilizados para carregar dados de páginas institucionais com os IDs informados, tais como o conteúdo dos mesmos cadastrados no sistema. Suas propriedades são:
collection, traz uma coleção de InstitutionalPage, ou seja, as páginas institucionais informadas.

Carrega as páginas institucionais disponíveis pelas tags informadas

É utilizados para carregar dados de páginas institucionais com as TAGS informados, tais como o conteúdo das mesmas cadastrados no sistema. Suas propriedades são:
collection, traz uma coleção de InstitutionalPage, ou seja, as páginas institucionais informadas.

Os parâmetros que podem ser utilizados são: 
ids, do tipo int, para determinar os IDs das tags que tem as páginas institucionais relacionadas.
sorts, do tipo string, para determinar a ordenação em que as páginas institucionais serão retornadas na coleção. Pode ser o slug de um campo extra, por exemplo.
sortDirections, do tipo string, para determinar o sentido da ordenação em que as páginas institucionais serão retornadas na coleção. Deve ser asc ou desc.