Marketplaces

Lista de Marketplaces

Includes disponíveis: form

Listar Marketplaces

GET https://api.dooki.com.br/v2/{alias}/marketplaces

Response

{
"data": [
{
"id": 1,
"alias": "mercadolivre",
"name": "Mercadolivre",
"auth_type": "oauth2",
"needs_category_association": true,
"needs_association": true,
"active": true,
"icon_url": "https://github.bubbstore.com/marketplaces/mercadolivre.svg"
},
{
"id": 2,
"alias": "b2w",
"name": "B2W",
"auth_type": "api_key",
"needs_category_association": false,
"needs_association": false,
"active": false,
"icon_url": "https://github.bubbstore.com/marketplaces/b2w.svg"
},
{
"id": 3,
"alias": "cnova",
"name": "CNOVA",
"auth_type": "api_key",
"needs_category_association": true,
"needs_association": true,
"active": false,
"icon_url": "https://github.bubbstore.com/marketplaces/cnova.svg"
}
]
}

Tabela de Marketplaces

Alias

Nome

mercadolivre

Mercado Livre

b2w

B2W

cnova

CNOVA

magalu

Magalu

madeiramadeira

Madeira Madeira

walmart

Walmart

dafiti

Dafiti

kanui

Kanui

tricae

Tricae

carrefour

Carrefour

mobly

Mobly

amazon

Amazon

zoom

Zoom

ricardoeletro

Ricardo Eletro

colombo

Colombo

Visualizar marketplace

GET https://api.dooki.com.br/v2/{alias}/marketplaces/{alias}

Listar categorias dos Marketplaces

Lista a árvore de categorias definidas pelo marketplace.

GET https://api.dooki.com.br/v2/{alias}/marketplaces/categories/{marketplace_alias}

Lista de marketplaces que necessitam de mapeamento das categorias da loja com as do Marketplaces.

Marketplace

Alias

Mercadolivre

mercadolivre

Madeira Madeira

madeiramadeira

Cnova

cnova

Associar categorias aos Marketplaces

Alguns Marketplaces trabalham com uma árvore de categorias já definidas. Devido a isso, é necessário realizar o mapeamento das categorias da loja com as do Marketplaces. Para fazer isso, existe um endpoint específico:

PUT https://api.dooki.com.br/v2/{alias}/marketplaces/categories/associate

Request

{
"category_id": 132,
"marketplace_id": 2,
"marketplace_category_id": null,
"marketplace_category_value": "ML1231223"
}

Parâmetro

Tipo

Obrigatório

Descrição

category_id

int

Sim

ID da categoria da loja

marketplace_id

int

Sim

ID do Marketplace

marketplace_category_id

string

Não

ID da categoria no Marketplace

marketplace_category_value

string

Sim

Nome da categoria no Marketplace

Contas de Marketplaces

Includes disponíveis: marketplace, stock

A API possibilida que o lojista gerencie múltiplas contas de um ou mais Marketplaces.

Listar contas de Marketplaces

GET https://api.dooki.com.br/v2/{alias}/marketplaces/accounts

Request

{
"marketplace_id": 1,
"stock_id": 35,
"auto_sync_catalog": true,
"name": "Conta Mercado Livre",
"price_attribute": "price_sale",
"price_percentage": 0,
"params": {
"listing_type_id": "bronze",
"allow_sku_without_stock": true
},
}

Response

{
"id": 3,
"stock_id": 35,
"active": true,
"auto_sync_catalog": true,
"name": "Conta Mercado Livre",
"marketplace_user_id": "50673958",
"price_attribute": "price_sale",
"price_percentage": 0,
"authorize_url": "https://url.com",
"params": {
"listing_type_id": "bronze",
"allow_sku_without_stock": true
},
"auth_params": {
"access_token": "access_token",
"expires_in": 1546103272,
"refresh_token": "refresh_token"
},
"marketplace": {
"data": {
"id": 1,
"alias": "mercadolivre",
"name": "Mercadolivre",
"auth_type": "oauth2",
"needs_category_association": true,
"icon_url": "https://github.bubbstore.com/marketplaces/mercadolivre.svg"
}
}
}

Criar conta de Marketplace

POST https://api.dooki.com.br/v2/{alias}/marketplaces/accounts

Parâmetro

Tipo

Obrigatório

Descrição

active

bool

Sim

Marca se a conta está ativa ou não.

marketplace_id

int

Sim

ID do Marketplace.

auto_sync_catalog

bool

Sim

Marca se o catálogo será sincronizado automaticamente.

name

string

Sim

Nome da conta

stock_id

int

Sim

ID do estoque que ficará associado a conta.

price_attribute

string

Sim

Define qual será o preço enviado. Valores aceitos: price_sale ou price_discount

price_percentage

float

Sim

Define qual a porcentagem aplicada ao preço do produto (pode ser um valor positivo ou negativo)

params

array

Não

Parâmetros específicos de cada Marketplace

Atualizar conta de Marketplace

PUT https://api.dooki.com.br/v2/{alias}/marketplaces/accounts/{id}

Excluir conta de Marketplace

DELETE https://api.dooki.com.br/v2/{alias}/marketplaces/accounts/{id}

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

active

boolean

Filtro de contas ativas e inativas

Parâmetros de Marketplaces

Mercado Livre

Parâmetro

Tipo

Obrigatório

Descrição

listing_type_id

string

Sim

Tipo de anúncio do Mercado Livre. Valores aceitos: gold_pro, gold_premium, gold_special, gold, silver, bronze, free

allow_sku_without_stock

bool

Sim

Marca se será permitido enviar SKU sem estoque. Caso sim, a quantidade padrão será 99999

Atributos

Alguns Marketplaces exigem que certos produtos possuam alguns atributos. Isso pode variar de acordo com a categoria que o produto pertence.

Para consultar os atributos requeridos de um produto, basta consultar o seguinte endpoint:

Listar atributos de um produto no Marketplace

GET https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/marketplaces/attributes

Request para atualizar atributos de um produto

{
"marketplace_id": 1,
"skus": [
{
"id": 1,
"name": "Tamanho",
"value_id": 123,
"value_name": "GG",
"required": true,
"catalog_required": true,
"variation_required": true,
}
]
}

Atualizar atributos de um produto

PUT https://api.dooki.com.br/v2/{alias}/catalog/products/{id}/marketplaces/attributes

Parâmetro

Tipo

Obrigatório

Descrição

marketplace_id

int

Sim

ID do marketplace

skus[name]

string

Sim

Nome do atributo

skus[value_id]

string

Sim

ID do valor do atributo no Marketplace

skus[value_name]

string

Sim

Nome do valor do atributo no Marketplace

skus[required]

boolean

Sim

Marca se o atributo é obrigatório

skus[catalog_required]

boolean

Sim

Marca se o atributo é obrigatório para ser listado no Marketplace

skus[variation_required]

boolean

Sim

Marca se o atributo é obrigatório para a criação de variações

Anúncios

Os anúncios possuem relacionamento direto com os produtos da loja. Um produto pode conter um ou mais anúncios, em diferentes Marketplaces.

Includes disponíveis: marketplace, account, product, suggestion

Criar anúncio

Entendemos que um anúncio no Marketplace é um produto cadastrado no catálogo. Devido a isso, existe um endpoint para exportar um ou mais produtos para uma determinada conta de Marketplace.

No exemplo abaixo, iremos exportar os produtos com os IDS 123 e 1234 para a conta de Marketplace com ID 4.

GET https://api.dooki.com.br/v2/{alias}/catalog/products/export/marketplace?id[]=123&id[]=1234&account_id=4

Também é possível exportar produtos através de um critério, como marca, categoria etc.

Response de anúncios

{
"id": 5,
"marketplace_id": 1,
"account_id": 3,
"account_name": "Conta Mercado Livre",
"status": "active",
"external_id": "MLB1160036757",
"price": 1532.58,
"url": "http://produto.mercadolivre.com.br",
"marketplace": {
"data": {
"id": 1,
"alias": "mercadolivre",
"name": "Mercadolivre",
"auth_type": "oauth2",
"needs_category_association": true,
"icon_url": "https://github.bubbstore.com/marketplaces/mercadolivre.svg"
}
}
}

Listar todos os anúncios

GET https://api.dooki.com.br/v2/{alias}/marketplaces/ids

Atualizar um anúncio

PUT https://api.dooki.com.br/v2/{alias}/marketplaces/ids/{id}

Parâmetro

Tipo

Obrigatório

Descrição

status

string

Não

Status do anúncio. Valores aceitos: closed, paused, active

price

float

Não

Preço do anúncio. Valor mínimo: 6.00

title

string

Não

Título do anúncio.

resource_id

int

Não

ID do produto que será vinculado.

Excluir um anúncio

DELETE https://api.dooki.com.br/v2/{alias}/marketplaces/ids/{id}

Importar um anúncio

POST https://api.dooki.com.br/v2/{alias}/marketplaces/ids/import?account_id={marketplaceAccountId}

Duplicar um anúncio

POST https://api.dooki.com.br/v2/{alias}/marketplaces/ids/{id}/duplicate

Parâmetro

Tipo

Obrigatório

Descrição

title

string

Sim

Título do anúncio

price

float

Sim

Preço do anúncio. Valor mínimo: 6.00

params

array

Sim

Parametros para duplicar o anúncio.

params[free_shipment]

boolean

Sim

Se o anúncio irá oferecer frete grátis.

params[increment_shipping_cost]

boolean

Sim

Se o valor do frete será adicionado ao preço do anúncio

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

status

String

Filtro por status do anúncio (valores aceitos: active, paused, closed)

marketplace_id

Array

Filtro por marketplace

marketplace_account

Array

Filtro por contas de marketplaces

synced

boolean

Filtra os anúncios sincronizados

Lista de erros

Includes disponíveis: account

Response de erros

{
"id": 63,
"message": "Produto não encontrado ao criar a venda. ID da venda: 11111111",
"read_at": "2019-01-23 08:32:59"
}

Listar erros

GET https://api.dooki.com.br/v2/{alias}/marketplaces/errors

Visualizar um erro

GET https://api.dooki.com.br/v2/{alias}/marketplaces/errors/{id}

Marcar um erro como lido

PUT https://api.dooki.com.br/v2/{alias}/marketplaces/errors/{id}/read

Excluir um erro

DELETE https://api.dooki.com.br/v2/{alias}/marketplaces/errors/{id}

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

status

string

Faz o filtro de erros de acordo com seu status(aceita apenas read e unread)