1. Ayuda
  2. Desarrolladores
Regresar

Categorías API

Categorías representan el listado de colección en una tienda.

Objeto de Categoría

Atributo Tipo Descripción
id cadena Identificador único de la categoría.
object cadena El nombre del tipo de objeto.
permalink cadena El permalink único de la categoría.
title cadena El nombre de la categoría.
order entero Posición en el cual se muestra la categría.
parent_id cadena Identificador de la categoría padre.
created_at timestamp Fecha de creación de la categoría.
updated_at timestamp Última fecha de actualización de la categoría.
children[] arreglo Las categorías hijo de la categoría.

Listar las Categorías

GET /v1/categories
{
  "data": [
    {
      "id": "cat_ciy2aof6o0000wv04kd4nzutn",
      "object": "category",
      "permalink": "lentes",
      "title": "Lentes",
      "order": 0,
      "parent_id": "cat_ciy2ao95s00004y04dnrajijx"
    },
    {
      "id": "cat_ciy2ao95s00004y04dnrajijx",
      "object": "category",
      "permalink": "hombre",
      "title": "Hombre",
      "order": 0,
      "parent_id": null
    }
  ]
}

Parámetros

Nombre Tipo Default Requerido Descripción
page entero 1 false Número de pagina a consultar.
per_page entero 50 false La cantidad de resultados a mostrar.

Listar las Categorías en forma de Árbol

GET /v1/categories/tree
{
  "data": [
    {
      "id": "cat_ciy2ao95s00004y04dnrajijx",
      "object": "category",
      "permalink": "hombre",
      "title": "Hombre",
      "order": 0,
      "parent_id": null,
      "updated_at": 1484684422,
      "created_at": 1484684422,
      "children": [
        {
          "id": "cat_ciy2aof6o0000wv04kd4nzutn",
          "object": "category",
          "permalink": "lentes",
          "title": "Lentes",
          "order": 0,
          "parent_id": "cat_ciy2ao95s00004y04dnrajijx",
          "updated_at": 1484684422,
          "created_at": 1484684422,
          "children": []
        }
      ]
    }
  ]
}

Parámetros

Nombre Tipo Default Requerido Descripción
page entero 1 false Número de pagina a consultar.
per_page entero 50 false La cantidad de resultados a mostrar.

Consultar una Categoría

GET /v1/categories/{id}
{
  "data": {
    "id": "cat_ciy2aof6o0000wv04kd4nzutn",
    "object": "category",
    "permalink": "lentes",
    "title": "Lentes",
    "order": 0,
    "parent_id": "cat_ciy2ao95s00004y04dnrajijx",
    "updated_at": 1484684422,
    "created_at": 1484684422
  }
}

Parámetros

Ningúno.

Consultar una Categoría en forma de Árbol

GET /v1/categories/{id}/tree
{
  "data": {
    "id": "cat_ciy2ao95s00004y04dnrajijx",
    "object": "category",
    "permalink": "hombre",
    "title": "Hombre",
    "order": 0,
    "parent_id": null,
    "updated_at": 1484684422,
    "created_at": 1484684422,
    "children": [
      {
        "id": "cat_ciy2aof6o0000wv04kd4nzutn",
        "object": "category",
        "permalink": "lentes",
        "title": "Lentes",
        "order": 0,
        "parent_id": "cat_ciy2ao95s00004y04dnrajijx",
        "updated_at": 1484684422,
        "created_at": 1484684422,
        "children": []
      }
    ]
  }
}

Parámetros

Ningúno.

Crear una Categoría

POST /v1/categories

Parámetros

Nombre Tipo Requerido Descripción
title cadena true El nombre de la categoría.
parent_id cadena false Identificador de la categoría padre.
order entero false Posición en el cual se muestra la categría.

Si es exitoso la respuesta será un objeto de categoría.

Actualizar una Categoría

POST /v1/categories/{id}

Parámetros

Nombre Tipo Requerido Descripción
title cadena true El nombre de la categoría.
parent_id cadena false Identificador de la categoría padre.
order entero false Posición en el cual se muestra la categría.

Si es exitoso la respuesta será un objeto de categoría.

Eliminar una Categoría

DELETE /v1/categories/{id}

Parámetros

Ningúno.

Si es exitoso la respuesta será un HTTP 204 No Content.