Documentación

CATEGORIAS

En MercadoShops permitimos armar tu propio árbol de categorías donde podrás agrupar tus publicaciones.

Este árbol no podrá tener mas de 3 niveles de profundidad y las publicaciones podrán pertenecer a cualquiera de ellas.

Indice

Categorías Principales Árbol de categorías Búsqueda por Id

Categorías Principales

Retorna las categorías raíces del shop

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

Parámetros

ParámetroValoresEjemplo
SHOP_ID Id de usuario https://api.mercadoshops.com/v1/shops/15XXXXX24/categories
[{
"id"
Id de categoría
Tipo
NUMERICO
"shop_id"
Id del Sitio
Tipo
NUMERICO
"position"
Orden en que se mostraran las categoría
Tipo
NUMERICO
"name"
Nombre descriptivo de la categoría
Tipo
STRING
"default_category"
Categoría por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Fecha de creación de la categoría
Tipo
Date(ISO_8601)
"last_updated"
Fecha de modificación de la categoría
Tipo
Date(ISO_8601)
}]
[{
"id"
5036867,
"shop_id"
2XXX8,
"position"
1,
"name"
"Libros, Revistas y Comics",
"default_category"
false,
"permalink"
"http://xxxxx.mercadoshops.com.ar/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 Categoría no encontrada
HTTP CODE: 400 Id de categoría debe ser númerico

Árbol de categorías

Retorna todas las categorías del shop, de todos los niveles, mostrando la relación padre-hijo.

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

Parámetros

ParámetroValoresEjemplo
SHOP_ID Id de usuario https://api.mercadoshops.com/v1/shops/15XXXXX24/categories/tree
[{
"id"
Id de categoría
Tipo
NUMERICO
"shop_id"
Id del Sitio
Tipo
NUMERICO
"position"
Orden en que se mostraran las categoría
Tipo
NUMERICO
"name"
Nombre descriptivo de la categoría
Tipo
STRING
"default_category"
Categoría por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Fecha de creación de la categoría
Tipo
Date(ISO_8601)
"last_updated"
Fecha de modificación de la categoría
Tipo
Date(ISO_8601)
"children"
[ Datos de las categorías hijas
Tipo
ARRAY de Objetos
{
"id"
Id de categoría
Tipo
NUMERICO
"parent_id"
Id de categoría padre
Tipo
NUMERICO
"shop_id"
Id del Sitio
Tipo
NUMERICO
"position"
Orden en que se mostraran las categoría
Tipo
NUMERICO
"name"
Nombre descriptivo de la categoría
Tipo
STRING
"default_category"
Categoría por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Fecha de creación de la categoría
Tipo
Date(ISO_8601)
"last_updated"
Fecha de modificación de la categoría
Tipo
Date(ISO_8601)
}
]
}]
[{
"id"
5036867,
"shop_id"
2XXX8,
"position"
1,
"name"
"Libros, Revistas y Comics",
"default_category"
false,
"permalink"
"http://xxxxx.mercadoshops.com.ar/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"
"Libros",
"default_category"
false,
"permalink"
"http://xxxxx.mercadoshops.com.ar/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 Categoría no encontrada
HTTP CODE: 400 Id de categoría debe ser númerico

Búsqueda por id

Retorna información acerca de la categoría específicada.

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

Parámetros

ParámetroValoresEjemplo
SHOP_ID Id de usuario https://api.mercadoshops.com/v1/shops/15XXXXX24/categories
CATEGORY_ID Id de category https://api.mercadoshops.com/v1/shops/15XXXXX24/categories/5036867
{
"id"
Id de categoría
Tipo
NUMERICO
"shop_id"
Id del Sitio
Tipo
NUMERICO
"position"
Orden en que se mostraran las categoría
Tipo
NUMERICO
"name"
Nombre descriptivo de la categoría
Tipo
STRING
"default_category"
Categoría por default
Tipo
BOOLEANO
"permalink"
Permalink
Tipo
STRING
"date_created"
Fecha de creación de la categoría
Tipo
Date(ISO_8601)
"last_updated"
Fecha de modificación de la categoría
Tipo
Date(ISO_8601)
}
{
"id"
5036867,
"shop_id"
2XXX8,
"position"
1,
"name"
"Libros, Revistas y Comics",
"default_category"
false,
"permalink"
"http://xxxxx.mercadoshops.com.ar/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 Categoría no encontrada
HTTP CODE: 400 Id de categoría debe ser númerico