Catálogo
Marcas
Listar marcas
GET https://api.dooki.com.br/v2/{alias}/catalog/brands
Request
Response
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
Response
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: |
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
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
Response
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: |
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
Variações
Includes disponíveis: values
Listar variações
GET https://api.dooki.com.br/v2/{alias}/catalog/variations
Request
Response
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
Response
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
Response
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
Response
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
Response simples
Response completo
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 |
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: |
priority | int | Não | Índice de prioridade que o produto tem no posicionamento de busca. Valores aceitos: |
is_digital | boolean | Não | Produto digital. Padrão: |
buy_similars | boolean | Não | Compra de produtos relacionados. Padrão: |
rating | int | Não | Nota do produto. Valores aceitos: |
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. |
google_category | string | Não | Categoria do produto no Google Merchant Center. |
seo_title | string | Não | Título da página do produto. |
seo_description | string | Não | Meta tag description. |
seo_keywords | string | Não | Meta tag keywords. |
canonical_url | string | Não | URL canônica do produto |
search_terms | string | Não | Termos de busca do produto separados em vírgula. |
categories_ids | array | Não | IDS das categorias que o produto pertence. |
filters_values_ids | array | Não | IDS dos valores de filtros que o produto possui. |
variations_ids | array | Não | IDS das variações que o produto possui. |
similars_ids | array | Não | IDS de produtos relacionados. |
skus | array | Não | Array de objetos SKU. Por enquanto só é permitido criar SKUS em massa. Para atualizar, você deverá fazer um request |
Listar SKUS de um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/skus
Atualizar ordem dos SKUS de um produto
PUT https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/skus/order
A sintaxe do request é o mesmo utilizado na ordenação de imagens de um SKU.
Filtros personalizados
Esse tipo de filtro não utiliza a sintaxe global. Neste caso, o parâmetro é passado individualmente via query string na URL.
Parâmetro | Tipo | Descrição |
brand_id[] | array | Array de IDS de marcas |
category_id[] | array | Array de IDS de categorias |
flag_id[] | array | Array de IDS de selos |
collection_id[] | array | Array de IDS de coleções |
Exemplo de um request com filtros personalizados:
GET https://api.dooki.com.br/v2/{alias}/products?brand_id[]=3&brand_id[]=4&category_id[]=6
A API retornará produtos das marcas com ID 3
, 4,
e categoria de ID 6
Exportar produtos
GET https://api.dooki.com.br/v2/{alias}/catalog/products/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.
Selos de um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/flags
Grupos de um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/groups
Comentários de um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/comments
Avaliações de um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/reviews
Combos de um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/combos
Coleções que um produto pertence
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/collections
Promoções que um produto pertence
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/promotions
Recomendações para um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/recommendations
Duplicar produto
POST https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/duplicate
Listar estoques de todos os SKUS de um produto
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/stocks
Atualização em massa
Atualização de produtos em massa
Exemplo de request que aumenta o preço de venda em 20% de todos os produtos, exceto os da marca com id 5
Através desse endpoint, é possível aterar os seguintes parâmetros de um produto e seus respectivos SKUS:
Status (ativo ou inativo)
Preço de venda
Preço promocional
PUT https://api.dooki.com.br/v2/{alias}/catalog/products/batch-edit
Parâmetro | Tipo | Obrigatório | Descrição |
attribute | string | Sim | O atributo que será atualizado. Valores aceitos: |
operation_type | string | Sim (se attribute for | Tipo de operação. Valores aceitos: |
value_type | string | Sim (se attribute for | Tipo do valor da operação. Valores aceitos: |
value | string | Sim | Novo valor aplicado |
restrictions | array | Sim | Regras de restrições de produtos |
Sincronizar estoques
Sincronizar estoques
Neste endpoint, é possível informar as respectivas quantidades em estoque de um SKU em cada estoque/armazém.
POST https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/stocks/sync
Parâmetro | Tipo | Obrigatório | Descrição |
skus | array | Sim | Array de SKUS do produto |
skus[id] | int | Sim | ID do SKU |
skus[stock_id] | int | Sim | ID do estoque |
skus[quantity] | int | Sim | Quantidade do SKU |
skus[min_quantity] | int | Sim | Quantidade mínima do SKU |
Exportar Skus de um estoque
Rota para exportar os produtos de um estoque específico, é necessário enviar por parâmetro o id do estoque:
GET https://api.dooki.com.br/v2/{alias}/catalog/stocks/export-skus
Parâmetro | Tipo | Obrigatório | Descrição |
stock_id | array | Sim | Id do estoque |
Produtos relacionados
Incluir ou excluir produtos relacionados
Request para ordenar os produtos relacionados
Listar produtos relacionados
GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/similars
Associar produtos relacionados
POST https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/similars
Excluir produtos relacionados
DELETE https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/similars
Ordenar produtos relacionados
PUT https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/similars
Batch de produtos relacionados
POST https://api.dooki.com.br/v2/{alias}/catalog/products/similars/batch
Para realizar um batch de produtos relacionados, você deverá enviar o parâmetro products_ids[]
com os IDS dos produtos que deseja criar o relacionamento. Dessa forma, todos os produtos informados se relacionarão entre si.
SKUS
Request para criar um SKU
Includes disponíveis: prices, images, firstImage, stocks, product, customizations
Listar SKUS
GET https://api.dooki.com.br/v2/{alias}/catalog/skus
Criar SKU
POST https://api.dooki.com.br/v2/{alias}/catalog/skus
Response (com includes)
Parâmetro | Tipo | Obrigatório | Descrição |
product_id | int | Sim | ID do produto pai |
sku | string | Sim | Código SKU |
erp_id | string | Não | Código ERP do SKU |
barcode | string | Não | Código de barras |
price_cost | float | Sim | Preço de custo |
price_sale | float | Sim | Preço de venda |
price_discount | float | Não | Preço promocional |
weight | float | Sim | Peso (em KG) |
height | float | Sim | Altura (em CM) |
width | float | Sim | Largura (em CM) |
length | float | Sim | Comprimento (em CM) |
quantity_managed | boolean | Sim | Quantidade de estoque gerenciada pelo sistema |
availability | int | Sim | Número de dias úteis de disponibilidade do SKU |
availability_soldout | int | Sim | Número de dias úteis de disponibilidade do SKU quando zerar o estoque |
blocked_sale | boolean | Sim | Venda bloqueada |
order | int | Não | Ordem de exibicação do produto |
variation_values_ids | array | Sim (se for produto com variações) | IDS dos valores de variações que o SKU possui. Exemplo: |
images | array | Não | Array de imagens. Pode conter duas propriedades: |
stock_quantity | int | Não | Quantidade em estoque. O sistema criará o estoque somente se o atributo |
stock_min_quantity | int | Não | Quantidade mínima em estoque. O sistema criará o estoque somente se o atributo |
customizations_ids | array | Não | ID das customizações que o SKU possui. |
Filtros personalizados
Esse tipo de filtro não utiliza a sintaxe global. Neste caso, o parâmetro é passado individualmente via query string na URL.
Parâmetro | Tipo | Descrição |
stock_quantity | int | Quantidade em estoque |
stock_min_quantity | int | Quantidade mínima em estoque |
Imagens
Exemplo de como enviar imagens via URL
Request para ordenar as imagens
Por padrão, as imagens não são retornadas no payload de SKUS. Utilize o parâmetro include=images
para que isso aconteça.
Listar imagens de um SKU
GET https://api.dooki.com.br/v2/{alias}/catalog/skus/{skuId}/images
Criar imagens
POST https://api.dooki.com.br/v2/{alias}/catalog/skus/{skuId}/images
Há disponíveis três formas de upload através do parâmetro upload_option
: resize
, crop
e fill_canvas
Parâmetro | Tipo | Obrigatório | Descrição |
upload_option | string | Não | Forma que o sistema redimensionará os arquivos. Valores aceitos: |
images | array | Sim | Você pode enviar URL's das imagens ou o IDs de SKUS. |
Excluir imagem
DELETE https://api.dooki.com.br/v2/{alias}/catalog/skus/{skuId}/images/{id}
Atualizar ordem das imagens
PUT https://api.dooki.com.br/v2/{alias}/catalog/skus/{skuId}/images/order
Importante: não se aplica quando um SKU utiliza fotos de outro.
Exportar SKUS
GET https://api.dooki.com.br/v2/{alias}/catalog/skus/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.
Grupos
Request para criar um Grupo
Response
Com este recurso é possível realizar um agrupamento de produtos.
Includes disponíveis: products
Listar grupos
GET https://api.dooki.com.br/v2/{alias}/catalog/groups
Criar grupo
POST https://api.dooki.com.br/v2/{alias}/catalog/groups
Parâmetro | Tipo | Obrigatório | Descrição |
name | string | Sim | Nome do grupo |
products_ids | array | Não | IDs de produtos |