Documentação

CATEGORIAS

Em MercadoShops permitimos construir sua própria árvore de categorias, onde você pode agrupar sues anúncios.

Esta árvore não pode ter mais de 3 níveis de profundidade e os anúncios podem pertencer a qualquer um deles.

Indice

Categorias principais Árvore de categorias Busca por Id

Categorias principais

Retorna as categorias raízes da loja

GET /v1/shops/{shop_id}/categories
Mostrar exemplo https://api.mercadoshops.com/v1/shops/{shop_id}/categories

Parâmetros

ParâmetroValoresExemplo
SHOP_ID Id da loja https://api.mercadoshops.com/v1/shops/15XXXXX24/categories
[{
"id"
Id de categoria
Tipo
NUMERICO
"shop_id"
Id da loja
Tipo
NUMERICO
"position"
Ordem em que se mostram as categorias
Tipo
NUMERICO
"name"
Nome descrito na categoria
Tipo
STRING
"default_category"
Categoria por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Data de criação da categoria
Tipo
Date(ISO_8601)
"last_updated"
Data de modificação da categoria
Tipo
Date(ISO_8601)
}]
[{
"id"
5036867,
"shop_id"
2XXX8,
"position"
1,
"name"
"Livros e Comics",
"default_category"
false,
"permalink"
"http://www.mercadoshops.com.br/libros-revistas-y-comics_qO5036867XtOcxSM",
"date_created"
"2015-08-10T15:07:33.000-04:00",
"last_updated"
"2015-08-10T15:07:33.000-04:00",
}]

Errores

HTTP CODE: 404 Categoria não encontrada
HTTP CODE: 400 Id da categoria deve ser numérico

Árvore de categorias

Retorna todas as categorias da loja, de todos os níveis, mostrando a relação pai-filho.

GET /v1/shops/{shop_id}/categories/tree
Mostrar exemplo https://api.mercadoshops.com/v1/shops/{shop_id}/categories/tree

Parâmetros

ParâmetroValoresExemplo
SHOP_ID Id da loja https://api.mercadoshops.com/v1/shops/15XXXXX24/categories/tree
[{
"id"
Id de categoría
Tipo
NUMERICO
"shop_id"
Id da loja
Tipo
NUMERICO
"position"
Ordem em que se mostram as categorias
Tipo
NUMERICO
"name"
Nome descrito na categoria
Tipo
STRING
"default_category"
Categoria por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Data de criação da categoria
Tipo
Date(ISO_8601)
"last_updated"
Data de modificação da categoria
Tipo
Date(ISO_8601)
"children"
[ Dados das categorias filhas
Tipo
ARRAY de Objetos
{
"id"
Id de categoria
Tipo
NUMERICO
"parent_id"
Id de categoria pai
Tipo
NUMERICO
"shop_id"
Id da loja
Tipo
NUMERICO
"position"
Ordem em que se mostram as categorias
Tipo
NUMERICO
"name"
Nome descrito da categoria
Tipo
STRING
"default_category"
Categoria por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Data de criação da categoria
Tipo
Date(ISO_8601)
"last_updated"
Data de modificação da categoria
Tipo
Date(ISO_8601)
}
]
}]
[{
"id"
5036867,
"shop_id"
2XXX8,
"position"
1,
"name"
"Livros e Comics",
"default_category"
false,
"permalink"
"http://www.mercadoshops.com.br/libros-revistas-y-comics_qO5036867XtOcxSM",
"date_created"
"2015-08-10T15:07:33.000-04:00",
"last_updated"
"2015-08-10T15:07:34.000-04:00",
"children"
[
{
"id"
5036868,
"parent_id"
5036867,
"shop_id"
2XXX8,
"position"
1,
"name"
"Livros",
"default_category"
false,
"permalink"
"http://wwww.mercadoshops.com.br/libros_qO5036868XtOcxSM",
"date_created"
"2015-08-10T15:07:33.000-04:00",
"last_updated"
"2015-08-10T15:07:34.000-04:00",
}]

Errores

HTTP CODE: 404 Categoria não encontrada
HTTP CODE: 400 Id de categoria deve ser numérico

Busca por id

Retorna informação sobre a categoria especificada.

GET /v1/shops/{shop_id}/categories/{category_id}
Mostrar exemplo https://api.mercadoshops.com/v1/shops/{shop_id}/categories/{category_id}

Parâmetros

ParâmetroValoresExemplo
SHOP_ID Id da loja https://api.mercadoshops.com/v1/shops/15XXXXX24/categories
CATEGORY_ID Id de categoria https://api.mercadoshops.com/v1/shops/15XXXXX24/categories/5036867
{
"id"
Id de categoria
Tipo
NUMERICO
"shop_id"
Id da loja
Tipo
NUMERICO
"position"
Ordem em que se mostram as categorias
Tipo
NUMERICO
"name"
Nome descrito da categoria
Tipo
STRING
"default_category"
Categoria por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Data de criação da categoria
Tipo
Date(ISO_8601)
"last_updated"
Data de modificação da categoria
Tipo
Date(ISO_8601)
}
{
"id"
5036867,
"shop_id"
2XXX8,
"position"
1,
"name"
"Livros e Comics",
"default_category"
false,
"permalink"
"http://www.mercadoshops.com.br/libros-revistas-y-comics_qO5036867XtOcxSM",
"date_created"
"2015-08-10T15:07:33.000-04:00",
"last_updated"
"2015-08-10T15:07:34.000-04:00",
}

Errores

HTTP CODE: 404 Categoria não encontrada
HTTP CODE: 400 Id de categoria deve ser numérico