Listar las categorías de una tienda

GET

/stores/{storeKey}/categories

Servidor de la API. El valor de host lo proporciona IDBI.

Devuelve las categorías de productos y de artículos de la tienda, ordenadas por nombre. La respuesta no está paginada.

Una categoría puede tener una categoría padre (parent_id). main_parent_id es la categoría raíz de su jerarquía y es null en una categoría raíz. types indica los módulos de la categoría raíz: products, items o services.

Si envía type, la respuesta solo incluye las categorías cuya raíz pertenece a ese módulo.

Authorizations

OpenApiKey
OpenApiToken

Parameters

Path Parameters

storeKey

required

string format: uuid

Identificador (UUID) de la tienda.

Example

2b7d9e40-c1a3-4f58-8e06-5a4d3c7b9f12

Query Parameters

type

string

Allowed values: products items services

Filtra por el módulo de la categoría raíz.

Example

products

Responses

200

Las categorías de productos y de artículos de la tienda, con su jerarquía. Sirve para reconstruir el árbol de categorías de su catálogo.

Van ordenadas por nombre y la respuesta no está paginada.
Una categoría raíz trae parent_id y main_parent_id en null; en las demás, main_parent_id apunta a la raíz de su jerarquía.
code es null si la categoría no tiene código.
Con type, solo llegan las categorías cuya raíz pertenece a ese módulo.

object

data

required

Array<object>

object

required

Identificador de la categoría.

string format: uuid

name

required

Nombre de la categoría.

string

types

required

Módulos de la categoría raíz.

Array<string>

Allowed values: products items services

code

required

Código de la categoría. Es null si no tiene.

string | null

parent_id

required

Identificador de la categoría padre. Es null en una categoría raíz.

string | null format: uuid

main_parent_id

required

Identificador de la categoría raíz de la jerarquía. Es null en una categoría raíz.

string | null format: uuid

Examples

{
  "data": [
    {
      "id": "a0c2e4f6-8b0d-4a24-9c6e-1d3f5a7b9c46",
      "name": "Bebidas",
      "types": [
        "products"
      ],
      "code": "BEB",
      "parent_id": null,
      "main_parent_id": null
    },
    {
      "id": "c2e4a6b8-0d2f-4c46-9e8a-3b5d7f9a1c35",
      "name": "Comidas",
      "types": [
        "products"
      ],
      "code": null,
      "parent_id": null,
      "main_parent_id": null
    },
    {
      "id": "b1d3f5a7-9c1e-4b35-8d7f-2a4c6e8b0d24",
      "name": "Hamburguesas",
      "types": [
        "products"
      ],
      "code": null,
      "parent_id": "c2e4a6b8-0d2f-4c46-9e8a-3b5d7f9a1c35",
      "main_parent_id": "c2e4a6b8-0d2f-4c46-9e8a-3b5d7f9a1c35"
    }
  ]
}

401

Credenciales ausentes, inválidas, deshabilitadas o vencidas. El campo error.description indica el motivo.

Formato de error de la autenticación y del control de acceso del token.

object

error

required

Detalle del error, con su código, su mensaje y su descripción.

object

code

required

Siempre es 0.

integer

message

required

Mensaje del error.

string

description

required

Detalle del error, cuando existe.

string | null

Examples

Falta una de las cabeceras

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es obligatorio"
  }
}

Token que no corresponde a la clave

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es inválido"
  }
}

Clave inexistente

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token no fue encontrado"
  }
}

Token deshabilitado

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token está deshabilitado"
  }
}

Token vencido

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token expiró"
  }
}

403

La tienda indicada en la ruta no pertenece al token. La respuesta es la misma para una tienda ajena y para una tienda inexistente.

Formato de error de la autenticación y del control de acceso del token.

object

error

required

Detalle del error, con su código, su mensaje y su descripción.

object

code

required

Siempre es 0.

integer

message

required

Mensaje del error.

string

description

required

Detalle del error, cuando existe.

string | null

Examples

{
  "error": {
    "code": 0,
    "message": "Acceso denegado",
    "description": "El token no tiene acceso a la tienda solicitada"
  }
}

422

El valor de type no es válido.

Formato de error cuando los datos enviados no superan la validación.

object

message

required

Mensaje general de validación.

string

errors

required

Mensajes de error agrupados por nombre de campo.

object

key

additional properties

Array<string>

Examples

{
  "message": "Uno o más de los datos que has ingresado no cumplen con los requisitos mínimos.",
  "errors": {
    "type": [
      "El campo type es inválido."
    ]
  }
}