Banners

A query de banners retorna informações dos banners ativos cadastrados no Admin da loja.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
Parâmetros de paginação		Sim	Parâmetros utilizados na paginação por cursor
bannerIds	[Long]	Não	Lista de IDs de banners específicos a serem buscados
partnerAccessToken	String	Não	Token de parceiro, utilizado para filtrar banners exibidos ao parceiro
sortDirection	Enum SortDirection	Não	Direção de ordenação. Por padrão é ASC
sortKey	Enum BannerSortKeys	Não	Chave de ordenação. Por padrão é ID

Campos

Campo	Descrição
altText	Texto alternativo do banner
bannerId	ID de cadastro do banner
bannerName	Nome do banner
bannerUrl	URL da imagem do banner
creationDate	Data de cadastro do banner
displayOnAllPages	Se deve ser exibido em todas as páginas
displayOnCategories	Se deve ser exibido em páginas de categorias
displayOnSearches	Se deve ser exibido em páginas de buscas
displayOnWebsite	Se deve ser exibido no site
displayToPartners	Se deve ser exibido para parceiros
height	Altura do banner
id	ID único no Storefront API
openNewTab	Se deve abrir o link em uma nova aba
order	Ordem do banner
position	Posição de exibição
searchTerms	Termos de busca que mostram o banner
title	Título do banner
urlOnClick	URL de redirecionamento ao clicar
width	Largura do banner

Exemplo

Neste exemplo são pedidas informações dos 2 primeiros banners de uma lista específica de IDs:

Request body

query{
	banners(first:2, bannerIds:[118460, 118461, 118463, 118464]){
    edges{
      node{
        bannerName
        creationDate
        position
        altText
      }
    }
  }
}

Mostrar resposta

JSON

{
  "data": {
    "banners": {
      "edges": [
        {
          "node": {
            "bannerName": "rodape1",
            "creationDate": "2017-07-13T11:00:29.833-03:00",
            "position": "Rodape",
            "altText": "rodape1"
          }
        },
        {
          "node": {
            "bannerName": "rodape2",
            "creationDate": "2017-07-13T11:02:14.860-03:00",
            "position": "Rodape",
            "altText": "rodape2"
          }
        }
      ]
    }
  }
}