API legada/Referência completa/Promoções, cupons e banners

Banners promocionais

Lê os banners promocionais da loja, com imagem, link e regras de exibição.

Um banner promocional é a imagem que divulga uma campanha na vitrine. Estas rotas são só de leitura: servem para um aplicativo ou site externo mostrar os mesmos banners da loja. Qualquer usuário autenticado pode chamar. Cada rota existe com dois nomes, promotion_banners e promotionbannerapi (o nome usado pelo aplicativo do seller), com o mesmo resultado.

GET/api/v1.0/promotion_bannersAutenticada

Listar os banners promocionais

Devolve os banners em páginas. Os banners vêm em banner e a paginação em search.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Fora disso vale 10.

GET/api/v1.0/promotion_banners/{id}Autenticada

Consultar um banner promocional

Devolve um banner pelo id.

Parâmetros de caminho

idstringobrigatório

Id do banner (UUID).

GET/api/v1.0/promotionbannerapiAutenticada

Listar os banners promocionais (nome do aplicativo)

Mesma rota de /promotion_banners, com o nome que o aplicativo do seller usa. Aceita os mesmos parâmetros.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

GET/api/v1.0/promotionbannerapi/{id}Autenticada

Consultar um banner promocional (nome do aplicativo)

Mesma rota de /promotion_banners/{id}.

Parâmetros de caminho

idstringobrigatório

Id do banner (UUID).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/promotion_banners?items_per_page=10"

Resposta

200Lista de banners

json

{
  "banner": [
    {
      "banner_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
      "type": "graphic",
      "status": "A",
      "position": 0,
      "title": "Campanha de inverno",
      "description": "Até 40% OFF em casacos e jaquetas",
      "url": "",
      "image": "/uploads/banners/inverno.png",
      "main_pair": {
        "image_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
        "detailed_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
        "position": 0,
        "detailed": { "image_path": "/uploads/banners/inverno.png", "alt": "Até 40% OFF em casacos e jaquetas" }
      },
      "object_type": "",
      "location_id": 0,
      "target": "_self",
      "image_pair_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
      "show_on_pages": "",
      "show_on_categories": "",
      "usergroup_ids": ""
    }
  ],
  "search": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

Campos da resposta

bannerarray

Banners da página. Na consulta de um banner, banner é um objeto.

banner[].banner_idstring

Id do banner (UUID).

banner[].typestring

Sempre graphic.

banner[].statusstring

ADHN

Status.

banner[].positioninteger

Ordem de exibição.

banner[].titlestring

Título (nome do banner).

banner[].descriptionstring

Texto alternativo da imagem.

banner[].urlstring

Link de destino; vazio quando não há.

banner[].imagestring

Caminho da imagem.

banner[].main_pairobject

Imagem no formato da Venddor 1.0: image_id, detailed_id, position e detailed (image_path e alt).

banner[].object_typestring

Sempre vazio.

banner[].location_idinteger

Sempre 0.

banner[].targetstring

Sempre _self.

banner[].image_pair_idstring

Igual a banner_id.

banner[].show_on_pagesstring

Páginas onde aparece, separadas por vírgula; vazio para todas.

banner[].show_on_categoriesstring

Categorias onde aparece, separadas por vírgula; vazio para todas.

banner[].usergroup_idsstring

Grupos de usuários que veem o banner; vazio para todos.

searchobject

page, items_per_page e total_items.

Erros

Status	Quando	Corpo
401	Sem credenciais	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
404	Banner inexistente	`{"message":"banner not found","status":404}`

Veja também

Banners promocionais

Lê os banners promocionais da loja, com imagem, link e regras de exibição.

GET/api/v1.0/promotion_bannersAutenticada

Listar os banners promocionais

Devolve os banners em páginas. Os banners vêm em banner e a paginação em search.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Fora disso vale 10.

GET/api/v1.0/promotion_banners/{id}Autenticada

Consultar um banner promocional

Devolve um banner pelo id.

Parâmetros de caminho

idstringobrigatório

Id do banner (UUID).

GET/api/v1.0/promotionbannerapiAutenticada

Listar os banners promocionais (nome do aplicativo)

Mesma rota de /promotion_banners, com o nome que o aplicativo do seller usa. Aceita os mesmos parâmetros.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

GET/api/v1.0/promotionbannerapi/{id}Autenticada

Consultar um banner promocional (nome do aplicativo)

Mesma rota de /promotion_banners/{id}.

Parâmetros de caminho

idstringobrigatório

Id do banner (UUID).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/promotion_banners?items_per_page=10"

Resposta

200Lista de banners

json

{
  "banner": [
    {
      "banner_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
      "type": "graphic",
      "status": "A",
      "position": 0,
      "title": "Campanha de inverno",
      "description": "Até 40% OFF em casacos e jaquetas",
      "url": "",
      "image": "/uploads/banners/inverno.png",
      "main_pair": {
        "image_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
        "detailed_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
        "position": 0,
        "detailed": { "image_path": "/uploads/banners/inverno.png", "alt": "Até 40% OFF em casacos e jaquetas" }
      },
      "object_type": "",
      "location_id": 0,
      "target": "_self",
      "image_pair_id": "65eca2c6-d6a5-46a9-a1bd-73bac5986545",
      "show_on_pages": "",
      "show_on_categories": "",
      "usergroup_ids": ""
    }
  ],
  "search": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

Campos da resposta

bannerarray

Banners da página. Na consulta de um banner, banner é um objeto.

banner[].banner_idstring

Id do banner (UUID).

banner[].typestring

Sempre graphic.

banner[].statusstring

ADHN

Status.

banner[].positioninteger

Ordem de exibição.

banner[].titlestring

Título (nome do banner).

banner[].descriptionstring

Texto alternativo da imagem.

banner[].urlstring

Link de destino; vazio quando não há.

banner[].imagestring

Caminho da imagem.

banner[].main_pairobject

Imagem no formato da Venddor 1.0: image_id, detailed_id, position e detailed (image_path e alt).

banner[].object_typestring

Sempre vazio.

banner[].location_idinteger

Sempre 0.

banner[].targetstring

Sempre _self.

banner[].image_pair_idstring

Igual a banner_id.

banner[].show_on_pagesstring

Páginas onde aparece, separadas por vírgula; vazio para todas.

banner[].show_on_categoriesstring

Categorias onde aparece, separadas por vírgula; vazio para todas.

banner[].usergroup_idsstring

Grupos de usuários que veem o banner; vazio para todos.

searchobject

page, items_per_page e total_items.

Erros

Status	Quando	Corpo
401	Sem credenciais	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
404	Banner inexistente	`{"message":"banner not found","status":404}`