YAyampi
Catálogo - Selos

Listar selos

Lista de selos com base nos parâmetros fornecidos

get/{alias}/catalog/flags

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/catalog/flags
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

idinteger

ID do selo.

activeboolean

Indica se o selo está ativo.

is_visibleboolean

Indica se o selo é exibido junto aos produtos na loja.

namestring

Nome do selo, exibido junto ao produto.

slugstring

Slug do selo, usado na composição da URL.

total_productsinteger

Quantidade de produtos que atendem às regras de restrição do selo.

text_colorstring

Cor do texto do selo, em hexadecimal.

background_colorstring

Cor de fundo do selo, em hexadecimal.

image_urlstring url

URL da imagem do selo, quando configurada no lugar do texto.

Example request

{
  "name": "Coleção 2017",
  "slug": "colecao-2017",
  "text_color": "#ffffff",
  "background_color": "#000000",
  "image_url": "https://image.com/selo.gif"
}

Response

Lista de selos retornada com sucesso

Example response

{
  "data": [
    {
      "name": "Coleção 2017",
      "slug": "colecao-2017",
      "text_color": "#ffffff",
      "background_color": "#000000",
      "image_url": "https://image.com/selo.gif",
      "created_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "updated_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.