Cómo gestionar las categorías vía API
π Más información sobre Categorías
Obtener todas las categorías
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/categorias?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- page: número de página (opcional). Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado (opcional). Por defecto 100 si no es proporcionado (valor máximo).
Respuesta:
Lista de categorías.
Ejemplo:
{
"result": {
"count": "3",
"items": [
{
"codigo": "CAT-01",
"activo": "1",
"nombre_es": "Categoría 1",
"nombre_en": "",
"codigo_padre": ""
},
{
"codigo": "CAT-02",
"activo": "0",
"nombre_es": "Categoría 2",
"nombre_en": "",
"codigo_padre": ""
},
{
"codigo": "CAT-03",
"activo": "1",
"nombre_es": "Categoría 3",
"nombre_en": "",
"codigo_padre": "CAT-01"
}
]
}
}
Obtener la cantidad de categorías
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/categorias/count?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Cantidad de categorías en formato JSON.
Ejemplo:
{
"result": {
"count": "24"
}
}
Obtener una categoría
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/categorias/{CODIGO CATEGORIA}?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Datos de una categoría.
Ejemplo:
{
"result": {
"item": {
"codigo": "CAT-03",
"activo": "1",
"nombre_es": "Categoría 3",
"nombre_en": "",
"codigo_padre": "CAT-01"
}
}
}
Crear una categoría
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/categorias?apikey={CLAVE DE API}
Método HTTP:
POST
Parámetros:
- codigo: código que se le asigna a la categoría para poder identificarla.
- codigo_padre: código de una categoría superior dentro de la cual se agregará la categoría creada.
- activo: indica si la categoría aparecerá publicada en el sitio web. Valores posibles: 0 (desactivado), 1 (activado).
- nombre_es: nombre de la categoría en idioma español.
- nombre_en: nombre de la categoría en idioma inglés.
Respuesta:
Cantidad de categorías creadas.
Ejemplo:
{
"result": {
"count": "1"
}
}
Modificar una categoría
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/categorias/{CODIGO CATEGORIA}?apikey={CLAVE DE API}
Método HTTP:
PUT
Parámetros:
- codigo: código que se le asigna a la categoría para poder identificarla. Si se envía este valor no puede estar vacío.
- activo: indica si la categoría aparecerá publicada en el sitio web. Valores posibles: 0 (desactivado), 1 (activado).
- nombre_es: nombre de la categoría en idioma español.
- nombre_en: nombre de la categoría en idioma inglés.
Nota: los campos que no se quieran modificar no deben ser incluidos en el conjunto de datos.
Respuesta:
Cantidad de categorías modificadas.
Ejemplo:
{
"result": {
"count": "1"
}
}
Borrar una categoría
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/categorias/{CODIGO CATEGORIA}?apikey={CLAVE DE API}
Método HTTP:
DELETE
Parámetros:
- Ninguno.
Respuesta:
Cantidad de categorías borradas.
Si la categoría tiene subcategorías, éstas serán eliminadas también.
Si hay productos asociados a la categoría o alguna de sus subcategorías, el borrado no se efectuará.
Ejemplo:
{
"result": {
"count": "3"
}
}
