Obtener categoría


GET /1/categories/:id

Método utilizado para obtener una determinada categoría de una tienda en particular.

Headers


{
  "Authorization": "Bearer {access_token}",
  "X-Shop-Id": "12345"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
Authorization	string	Si	Bearer + access_token	Token obtenido mediante client_id y client_secret.
X-Shop-Id	string	Si	String numérico	Identificador único de la tienda a la cual se desea obtener sus ventas.

Params


{
  "id": "category-1234"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
id	string	Si	`category-{id}`	Especifica qué categoría obtener a través de su identificador único.

Response exitosa: 200 Ok


{
  "id": "category-1234",
  "name": "Remeras",
  "slug": "remeras",
  "parent_id": null,
  "google_category_id": 0,
  "children": [
    {
      "id": "category-12345",
      "name": "Remeras manga corta",
      "slug": "remeras-manga-corta",
      "parent_id": "category-35259",
      "google_category_id": 0,
      "children": [
        //...
      ]
    },
    //..
  ]
}

Campos de la respuesta

Atributo	Tipo	Descripción
id	string	Corresponde al id de la categoría.
name	string	Corresponde al nombre de la categoría.
slug	string	Corresponde al nombre de la categoría en formato link.
parent_id	string	Corresponde a la categoría padre de la categoría en cuestión. Si su valor es null, entonces es una categoría root.
google_category_id	int	Corresponde al identificador de categoría de Google que fue asignado a dicha categoría.
children[]	[object]	Contiene todas las sub categorías hijas de la categoría en cuestión. Si se obtiene array vacío, entonces la categoría en cuestión no posee hijas.
children[].id	string	Corresponde al id de la categoría.
children[].name	string	Corresponde al nombre de la categoría.
children[].slug	string	Corresponde al nombre de la categoría en formato link.
children[].parent_id	string	Corresponde a la categoría padre de la categoría en cuestión. Si su valor es null, entonces es una categoría root.
children[].google_category_id	int	Corresponde al identificador de categoría de Google que fue asignado a dicha categoría.
children[].children[]	[object]	Corresponde al mismo formato de children y puede crecer indefinidamente de manera recursiva (una categoría puede tener n niveles de sub categorías hijas).

El array children puede crecer indefinidamente de forma recursiva: cada elemento hijo puede tener a su vez su propio array children con el mismo formato, permitiendo n niveles de sub categorías.

Responses de error

En caso de que la respuesta http no sea 200, entonces se debe considerar el error.

Atributo	Tipo	Descripción
status	int	Http code de respuesta.
code	string	Código de error, indica la naturaleza del mismo.
msg	string	Mensaje de error.

Ejemplo response 401 Unauthorized:


{
  "status": 401,
  "code": "error",
  "msg": "Unauthorized"
}

Ejemplo response 400 Bad Request genérico:


{
  "status": 400,
  "code": "request_error",
  "msg": "Send valid data"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada requerido no es enviado:


{
  "status": 400,
  "code": "param_required",
  "msg": "invalid <param_name>. The value is required"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada es inválido:


{
  "status": 400,
  "code": "param_invalid",
  "msg": "Invalid <param_name>. The value is invalid"
}

Ejemplo response 404 Not Found:


{
  "status": 404,
  "code": "not_found",
  "msg": "Unexisting or deleted resource"
}

Ejemplo response 500 Internal Server Error:


{
  "status": 500,
  "code": "server_error",
  "msg": "Something went wrong"
}