Comment on page
Catálogo

Marcas
Listar marcas
GET https://api.dooki.com.br/v2/{alias}/catalog/brands
Request
{
    "active": true,
    "featured": true,
    "name": "Brand",
    "description": "Description test",
    "logo_url": "http://foo.bar/logo.png",
}
Response
{
    "data": [
        {
            "id": 1,
            "active": true,
            "featured": true,
            "name": "Brand",
            "description": "Description test",
            "logo_url": "https://jarvis.bubbstore.com/brand-logo.png",
        },
    ]
}
Criar marca
POST https://api.dooki.com.br/v2/{alias}/catalog/brands
Parâmetro
Tipo
Obrigatório
Descrição
active
boolean
Sim
Status da marca
featured
boolean
Sim
Marca em destaque
name
string
Sim
Nome da marca
description
string
Não
Descrição da marca
logo_url
string
Não
URL do logotipo da marca
Visualizar marca
GET https://api.dooki.com.br/v2/{alias}/catalog/brands/{id}
Atualizar marca
PUT https://api.dooki.com.br/v2/{alias}/catalog/brands/{id}
Excluir marca
DELETE https://api.dooki.com.br/v2/{alias}/catalog/brands/{id}
Categorias
 Includes disponíveis: seo, children, parent, marketplaces
Listar categorias
GET https://api.dooki.com.br/v2/{alias}/catalog/categories
Por padrão, a API retorna todas as categorias. Se você deseja listar apenas os pais, basta adicionar o parâmetro /categories?onlyParents=true.
Request
{
    "active": true,
    "featured": false,
    "name": "Category",
    "slug": "category",
    "seo_title": "Page title for category",
    "seo_keywords": "meta, tags, keywords",
    "seo_description": "Seo description",
    "banners_ids": [1, 2, 3],
    "external_url": "http://www.link.com",
    "canonical_url": "http://www.link.com"
}
Response
{
    "data": [
        {
            "id": 400,
            "active": true,
            "featured": false,
            "parent_id": null,
            "ml_category": null,
            "name": "Category",
            "slug": "category",
            "url": "https://www.domain.com.br/category",
            "sort_by": "relevance",
            "price_factor": 1.00,
            "total_banners": 0,
            "external_url": "http://www.link.com",
            "canonical_url": "http://www.link.com",
            "seo": {
                "data": {
                    "seo_title": "Page title for category",
                    "seo_keywords": "meta, tags, keywords",
                    "seo_description": "Seo description"
                }
            },
            "parent": {},
            "children": []
        },
    ]
}
Criar categoria
POST https://api.dooki.com.br/v2/{alias}/catalog/categories
Parâmetro
Tipo
Obrigatório
Descrição
parent_id
int
Não
ID da categoria pai.
active
boolean
Sim
Status da categoria.
featured
boolean
Não
Categoria em destaque
ml_category
string
Não
ID da categoria no Mercado Livre
price_factor
float
Não
Fator de multiplicação
name
string
Sim
Nome da categoria
slug
string
Não
Slug da categoria
seo_title
string
Não
Título da página da categoria
seo_keywords
string
Não
Meta tag keywords da categoria
seo_description
string
Não
Meta tag description da categoria
external_url
string
Não
Link externo da categoria.
canonical_url
string
Não
Link canônico da categoria.
order
int
Não
Índice de ordenação da categoria
sort_by
string
Não
Tipo de ordenação dos produtos da categoria. Valores aceitos: relevance, highest_price, lowest_price, best_rating, name_asc, name_desc, random, best_sellers
banners_ids
array
Não
Lista de banners que a categoria possuirá.
Visualizar categoria
GET https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}
Atualizar categoria
PUT https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}
Excluir categoria
DELETE https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}
Lista de produtos associados a uma categoria
GET https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}/products
Associar produtos a uma categoria
PUT https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}/products
Excluir produtos de uma categoria
DELETE https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}/products
Lista de banners associados a uma categoria
GET https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}/banners
Você deverá enviar um json com os IDS dos produtos que deseja associar ou excluir.
Incluir ou excluir produtos de uma categoria
{
    "products_ids": [1, 2, 3, 4, 5]
}
Exportar categorias
GET https://api.dooki.com.br/v2/{alias}/catalog/categories/export
Dica: os filtros de busca também estão disponíveis no endpoint de exportação.
O sistema enviará para o usuário um e-mail com o link para download da planilha com os registros.
Associar produtos de outras categorias
POST https://api.dooki.com.br/v2/{alias}/catalog/categories/{id}/copy-products
Esse recurso é útil quando você precisa transferir produtos de outras categorias. Você deverá enviar em seu request os IDS das categorias dessa forma: "categories_ids": [1,2,3,4].
A API irá associar todos os produtos das categorias 1,2,3,4.
Selos
Listar selos
GET https://api.dooki.com.br/v2/{alias}/catalog/flags
Request
{
    "active": true,
    "is_visible": true,
    "name": "Coleção 2017",
    "slug": "colecao-2017",
    "text_color": "#ffffff",
    "background_color": "#000000",
    "image_url": "http://image.com/selo.gif",
}
Response
{
    "data": [
        {
            "id": 163,
            "active": true,
            "is_visible": true,
            "name": "Coleção 2017",
            "slug": "colecao-2017",
            "text_color": "#ffffff",
            "background_color": "#000000",
            "image_url": "http://image.com/selo.gif",
        },
    ]
}
Criar selo
POST https://api.dooki.com.br/v2/{alias}/catalog/flags
Parâmetro
Tipo
Obrigatório
Descrição
active
boolean
Sim
Status do selo
is_visible
boolean
Não
Selo visível. Padrão: true.
name
string
Sim
Nome do selo.
slug
string
Não
Slug do selo.
text_color
string(7)
Não
Código hexadecimal da cor do texto.
background_color
string(7)
Não
Código hexadecimal do fundo.
image_url
string
Não
URL da imagem que será usada no selo.
Visualizar selo
GET https://api.dooki.com.br/v2/{alias}/catalog/flags/{id}
Atualizar selo
PUT https://api.dooki.com.br/v2/{alias}/catalog/flags/{id}
Excluir selo
DELETE https://api.dooki.com.br/v2/{alias}/catalog/flags/{id}
Lista de produtos associados a um selo
GET https://api.dooki.com.br/v2/{alias}/catalog/flags/{id}/products
Associar produtos a um selo
POST https://api.dooki.com.br/v2/{alias}/catalog/flags/{id}/products
Excluir produtos de um selo
DELETE https://api.dooki.com.br/v2/{alias}/catalog/flags/{id}/products
Você deverá enviar um json com os IDS dos produtos que deseja associar ou excluir.
Incluir ou excluir produtos de um selo
{
    "products_ids": [1, 2, 3, 4, 5]
}
Variações
 Includes disponíveis: values
Listar variações
GET https://api.dooki.com.br/v2/{alias}/catalog/variations
Request
{
    "name": "Cor"
}
Response
{
    "data": [
        "id": 13,
        "name": "Cor",
        "values": {
            "data": [
                {
                    "id": 490,
                    "name": "Amarelo",
                    "color": "#fff705",
                },
                {
                    "id": 1067,
                    "name": "Amarelo Floral",
                    "color": null,
                },
            ]
        }
    ]
}
Criar variação
POST https://api.dooki.com.br/v2/{alias}/catalog/variations
Parâmetro
Tipo
Obrigatório
Descrição
name
string
Sim
Nome da variação.
Visualizar variação
GET https://api.dooki.com.br/v2/{alias}/catalog/variations/{id}
Atualizar variação
PUT https://api.dooki.com.br/v2/{alias}/catalog/variations/{id}
Excluir variação
DELETE https://api.dooki.com.br/v2/{alias}/catalog/variations/{id}
Valores de variações
Listar valores de uma variação
GET https://api.dooki.com.br/v2/{alias}/catalog/variations/{variationId}/values
Request
{
    "name": "Branco",
    "color": "#ffffff",
    "image_url": "https://image-url.com/image.jpg"
}
Response
{
    "data": {
        "id": 1,
        "name": "Branco",
        "color": "#ffffff",
        "image_url": "https://image-url.com/image.jpg"
    }
}
Criar valor de variação
POST https://api.dooki.com.br/v2/{alias}/catalog/variations/{variationId}/values
Parâmetro
Tipo
Obrigatório
Descrição
name
string
Sim
Nome do valor de variação.
color
string
Não
Código hexadecimal de uma cor.
image_url
string
Não
URL da imagem que será usada no valor de variação.
Visualizar valor de uma variação
GET https://api.dooki.com.br/v2/{alias}/catalog/variations/{variationId}/values/{id}
Atualizar valor de variação
PUT https://api.dooki.com.br/v2/{alias}/catalog/variations/{variationId}/values/{id}
Excluir valor de variação
DELETE https://api.dooki.com.br/v2/{alias}/catalog/variations/{variationId}/values/{id}
Filtros
Os filtros possuem quase a mesma estrutura de uma variação, porém, eles possuem uma outra finalidade, que é exclusivamente para a busca de produtos.
 Includes disponíveis: values
Listar filtros
GET https://api.dooki.com.br/v2/{alias}/catalog/filters
Request
{
    "name": "Tamanho",
    "searchable": true,
    "navigation": false
}
Response
{
    "data": [
        "id": 1,
        "name": "Tamanho",
        "searchable": true,
        "navigation": false,
        "values": {
            "data": [
                {
                    "id": 1,
                    "name": "P",
                    "color": null,
                },
                {
                    "id": 2,
                    "name": "M",
                    "color": null,
                },
            ]
        }
    ]
}
Criar filtro
POST https://api.dooki.com.br/v2/{alias}/catalog/filters
Parâmetro
Tipo
Obrigatório
Descrição
name
string
Sim
Nome do filtro.
searchable
boolean
Não
Filtro buscável.
navigation
boolean
Não
Filtro visível no menu de navegação.
Visualizar filtro
GET https://api.dooki.com.br/v2/{alias}/catalog/filters/{id}
Atualizar filtro
PUT https://api.dooki.com.br/v2/{alias}/catalog/filters/{id}
Excluir filtro
DELETE https://api.dooki.com.br/v2/{alias}/catalog/filters/{id}
Valores de filtros
Listar valores de um filtro
GET https://api.dooki.com.br/v2/{alias}/catalog/filters/{filterId}/values
Request
{
    "name": "M",
    "color": null,
    "image_url": "https://image-url.com/image.jpg"
}
Response
{
    "data": {
        "id": 1,
        "name": "M",
        "color": null,
        "image_url": "https://image-url.com/image.jpg"
    }
}
Criar valor de filtro
POST https://api.dooki.com.br/v2/{alias}/catalog/filters/{filterId}/values
Parâmetro
Tipo
Obrigatório
Descrição
name
string
Sim
Nome do valor de filtro.
color
string
Não
Código hexadecimal de uma cor.
image_url
string
Não
URL da imagem que será usada no filtro.
Visualizar valor de um filtro
GET https://api.dooki.com.br/v2/{alias}/catalog/variations/{filterId}/values/{id}
Atualizar valor de filtro
PUT https://api.dooki.com.br/v2/{alias}/catalog/variations/{filterId}/values/{id}
Excluir valor de filtro
DELETE https://api.dooki.com.br/v2/{alias}/catalog/variations/{filterId}/values/{id}
Produtos
 Includes disponíveis: dates, brand, extras, texts, seo, filters, flags, variations, categories, images, skus, firstImage, searchAttributes, reviews, combos
Listar produtos
GET https://api.dooki.com.br/v2/{alias}/catalog/products
Criar produto
POST https://api.dooki.com.br/v2/{alias}/catalog/products
Atualizar produto
PUT https://api.dooki.com.br/v2/{alias}/catalog/products/{id}
Excluir produto
DELETE https://api.dooki.com.br/v2/{alias}/catalog/products/{id}
Request
{
    "simple": true,
    "brand_id": 1,
    "erp_id": 1212,
    "active": true,
    "searchable": true,
    "is_digital": false,
    "buy_similars": false,
    "priority": 1,
    "rating": 5,
    "ncm": "NCM",
    "name": "Produto X",
    "slug": "produto-x",
    "video": "https://youtube.com",
    "description": "Descrição",
    "specifications": "Especificação",
    "measures": "Medidas",
    "gift_value": 1.00,
    "seo_title": "Page title",
    "seo_description": "Meta tag description",
    "seo_keywords": "Meta tag keywords",
    "canonical_url": "canonical_url",
    "search_terms": "search, terms, for, better, search",
    "categories_ids": [1, 2, 3, 4],
    "flags_ids": [1, 2, 3, 4],
    "filters_values_ids": [1, 2, 3, 4],
    "variations_ids": [1, 2, 3, 4],
    "similars_ids": [1, 2, 3, 4],
    "skus": [
        {
            "sku": "SKU-TEST-API",
            "erp_id": "01-753-Rose",
            "barcode": "barcode-test",
            "price_cost": 12.3,
            "price_sale": 30,
            "price_discount": 25,
            "weight": 1,
            "height": 1,
            "width": 1,
            "length": 1,
            "quantity_managed": false,
            "availability": 1,
            "availability_soldout": 1,
            "blocked_sale": false,
            "variations_values_ids": [490],
            "images": [
                {
                    "url": "http://www.site.com/image1.jpg",
                },
                {
                    "url": "http://www.site.com/image2.jpg",
                }
            ]   
        }
    ]
}
Response simples
{
    "data": [
        {
            "id": 3254,
            "merchant_id": 3,
            "active": true,
            "simple": false,
            "has_variations": true,
            "name": "Product name 1",
            "slug": "product-name-1",
            "rating": 0,
            "url": "https://www.domain.com.br/slug/p"
        },
        {
            "id": 3254,
            "merchant_id": 3,
            "active": true,
            "simple": true,
            "has_variations": true,
            "name": "Product name 2",
            "slug": "product-name-2",
            "rating": 0,
            "url": "https://www.domain.com.br/slug-2/p"
        },
    ]
}
Response completo
{
    "data": {
        "id": 3254,
        "merchant_id": 3,
        "active": true,
        "simple": true,
        "has_variations": true,
        "name": "Product name 2",
        "slug": "product-name-2",
        "rating": 0,
        "url": "https://www.domain.com.br/slug-2/p",
        "dates": {
            "data": {
                "created_at": {
                    "date": "2014-06-04 20:05:57.000000",
                    "timezone_type": 3,
                    "timezone": "America/Sao_Paulo"
                },
                "updated_at": {
                    "date": "2014-08-22 10:51:40.000000",
                    "timezone_type": 3,
                    "timezone": "America/Sao_Paulo"
                }
            }
        },
        "brand": {
            "data": {
                "id": 48,
                "active": true,
                "featured": false,
                "name": "Ione Enxovais",
                "description": null,
                "logo_url": null,
            }
        },
        "extras": {
            "data": {
                "video": "http://youtube.com",
                "search_terms": "edredom, edredom king, edredom florido, edredom estampado, edredom rose",
                "ncm": null,
            }
        },
        "texts": {
            "data": {
                "description": "<p>01 Edredom 2,80m x 2,70m<br />\r\n02 Porta Travesseiros 90cm x 60cm</p>\r\n",
                "specifications": "<p>Tecidos Externos: 100% Algod&atilde;o 150 Fios<br />\r\nEnchimento: 100% Poli&eacute;ster</p>\r\n",
                "measures": null
            }
        },
        "seo": {
            "data": {
                "seo_title": "Edredom Casal King Senegal Cor Rose 03 Pecas",
                "seo_description": "Edredom Casal King 100% Algodão 150 Fios",
                "seo_keywords": ""
            }
        },
        "filters": {
            "data": [
                {
                    "name": "Cor",
                    "value": "Rosê",
                    "value_id": 483,
                    "color": "#d6878a"
                },
            ]
        },
        "flags": {
            "data": []
        },
        "variations": {
            "data": [
                {
                    "id": 13,
                    "name": "Cor",
                    "values": [
                        {
                            "id": 385,
                            "value": "Rosê",
                            "color": "#e3adbe"
                        },
                        {
                            "id": 397,
                            "value": "Marrom",
                            "color": "#783d1a"
                        }
                    ]
                }
            ]
        },
        "categories": {
            "data": [
                {
                    "id": 137,
                    "name": "Casal"
                },
                {
                    "id": 144,
                    "name": "Edredom"
                }
            ]
        },
        "images": {
            "data": [
                {
                    "small": {
                        "width": 120,
                        "height": 100,
                        "url": "https://jarvis.bubbstore.com/assets/stores/store-alias/uploads/images/edredom-casal-king-senegal-cor-rose-tecido-algodao-150-fios-538ff60197af1-small.jpg"
                    },
                    "thumb": {
                        "width": 225,
                        "height": 190,
                        "url": "https://jarvis.bubbstore.com/assets/stores/store-alias/uploads/images/edredom-casal-king-senegal-cor-rose-tecido-algodao-150-fios-538ff60197af1-thumb.jpg"
                    },
                    "medium": {
                        "width": 545,
                        "height": 465,
                        "url": "https://jarvis.bubbstore.com/assets/stores/store-alias/uploads/images/edredom-casal-king-senegal-cor-rose-tecido-algodao-150-fios-538ff60197af1-medium.jpg"
                    },
                    "large": {
                        "width": 1200,
                        "height": 1021,
                        "url": "https://jarvis.bubbstore.com/assets/stores/store-alias/uploads/images/edredom-casal-king-senegal-cor-rose-tecido-algodao-150-fios-538ff60197af1-large.jpg"
                    }
                },
            ]
        },
        "skus": {
            "data": [
                {
                    "id": 5657,
                    "sku": "01-752-Rose",
                    "blocked_sale": true,
                    "barcode": null,
                    "title": "Edredom Casal King Senegal 03 Pecas Rosê",
                    "days_availability": 0,
                    "days_availability_formated": "Imediata",
                    "width": 30,
                    "height": 30,
                    "length": 30,
                    "weight": 4,
                    "quantity_managed": false,
                    "variations": [
                        {
                            "name": "Cor",
                            "value": "Rosê",
                            "value_id": 385
                        }
                    ],
                    "stocks": []
                },
                {
                    "id": 5658,
                    "sku": "01-752-Marrom",
                    "blocked_sale": true,
                    "barcode": null,
                    "title": "Edredom Casal King Senegal 03 Pecas Marrom",
                    "days_availability": 0,
                    "days_availability_formated": "Imediata",
                    "width": 30,
                    "height": 30,
                    "length": 30,
                    "weight": 4,
                    "quantity_managed": false,
                    "variations": [
                        {
                            "name": "Cor",
                            "value": "Marrom",
                            "value_id": 397
                        }
                    ],
                    "stocks": []
                }
            ]
        },
    }   
}
Parâmetro
Tipo
Obrigatório
Descrição
simple
boolean
Sim
Produto simples ou não. Para produtos que possuem variações, o valor deve ser false.
brand_id
int
Sim
ID da marca.
erp_id
int
Não
Código do produto no ERP.
active
boolean
Sim
Produto ativo.
searchable
boolean
Não
Produto buscável. Padrão: true.
priority
int
Não
Índice de prioridade que o produto tem no posicionamento de busca. Valores aceitos: 1, 2, 3
is_digital
boolean
Não
Produto digital. Padrão: false.
buy_similars
boolean
Não
Compra de produtos relacionados. Padrão: false.
rating
int
Não
Nota do produto. Valores aceitos: 1, 2, 3, 4 ou 5.
ncm
string
Não
Código NCM do produto.
name
string
Sim
Nome do produto.
slug
string
Não
Slug do produto.
video
string
Não
URL do vídeo do produto.
description
string
Não
Descrição do produto.
specifications
string
Não
Especificação do produto.
measures
string
Não
Medidas do produto.
gift_value
float
Não
Valor da embalagem de presente do produto.
Parâmetro	Tipo	Obrigatório	Descrição
active	boolean	Sim	Status da marca
featured	boolean	Sim	Marca em destaque
name	string	Sim	Nome da marca
description	string	Não	Descrição da marca
logo_url	string	Não	URL do logotipo da marca