{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/item-categories","auth":"required","method":"get","examples":{"codes":[{"language":"text","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://api.alegra.com/api/v1/item-categories -u usuario:::at:::alegra.co:mitoken'"}]},"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"id\": \"2\",\n        \"name\": \"Ropa para hombre\",\n        \"description\": \"Ropa deportiva\",\n        \"status\": \"inactive\",\n        \"image\": {\n            \"id\": 59,\n            \"name\": \"descarga.jfif\",\n            \"url\": \"https://imageFilePath...\"\n        }\n    },\n    {\n        \"id\": \"5\",\n        \"name\": \"Ropa para Mujer\",\n        \"description\": \"Ropa deportiva\",\n        \"status\": \"inactive\"\n    },\n    {\n        \"id\": \"1\",\n        \"name\": \"Telas\",\n        \"description\": \"De la mejor calidad\",\n        \"status\": \"active\",\n        \"image\": {\n            \"id\": 56,\n            \"name\": \"descarga.jfif\",\n            \"url\": \"https://imageFilePath...\"\n        }\n    },\n    {\n        \"id\": \"3\",\n        \"name\": \"Lavandería\",\n        \"description\": \"\",\n        \"status\": \"active\"\n    },\n    {\n        \"id\": \"4\",\n        \"name\": \"Ferretería\",\n        \"description\": \"\",\n        \"status\": \"active\"\n    },\n    {\n        \"id\": \"6\",\n        \"name\": \"Tecnología\",\n        \"description\": \"\",\n        \"status\": \"active\"\n    }\n]","name":""},{"status":400,"language":"json","code":"{\n    \"code\": 903,\n    \"message\": \"El límite de categorías para retornar debe estar entre 0 y 30\"\n}","name":"Bad Request - Limite sobrepasa máximo permitido"}]},"settings":"","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual categoría de ítem se quiere consultar. Por ejemplo para consultar desde la categoría 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"5e30a95168635b002caa0798"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de categorías de ítem a partir del inicio que se desea retornar. Por defecto retorna 30 categorías. Si este valor es mayor que 30, la aplicación retorna error.","required":false,"in":"query","ref":"","_id":"5e30a95168635b002caa0797"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar las categorías. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).","required":false,"in":"query","ref":"","_id":"5e30a95168635b002caa0796"},{"name":"order_field","type":"string","default":"name","desc":"Campo por el cual se desea ordenar las categorías de ítem, las opciones posibles son name, id y description.","required":false,"in":"query","ref":"","_id":"5e30a95168635b002caa0795"},{"name":"query","type":"string","default":"","desc":"Cadena de texto que se quiere utilizar para buscar las categorías de ítem que en su nombre o descripción contienen dicho texto. Por ejemplo si se desea buscar las categorías de ítem que contengan la palabra cuaderno, se envía query=cuaderno.","required":false,"in":"query","ref":"","_id":"5e30a95168635b002caa0794"}]},"next":{"description":"","pages":[]},"title":"Lista de categorías","type":"endpoint","slug":"lista-de-categorías-1","excerpt":"Endpoint que permite consultar las categorías de ítem registradas en la aplicación","body":"Endpoint que retorna las categorías de ítem registradas en la cuenta de Alegra. Si no se envía límite de categorías de ítem por defecto se envían 30 categorías de ítem.  \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atención\",\n  \"body\": \"Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error:\\n```\\n{\\n  \\\"code\\\": 903,\\n  \\\"message\\\" : \\\"El límite de categorías para retornar debe estar entre 0 y 30\\\"\\n}\\n```\"\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e30a95168635b002caa0793","project":"56abd2434e4b730d009eb10a","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":31,"createdAt":"2016-01-29T20:57:39.712Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Categorías de items","slug":"categoría-de-ítem","order":11,"from_sync":false,"reference":false,"_id":"5e3098aba5919200612d0c33","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2020-01-28T20:25:15.140Z","__v":0},"user":"56abd213d4432d1900eed227","createdAt":"2020-01-28T21:36:17.994Z","__v":2,"parentDoc":null}

getLista de categorías

Endpoint que permite consultar las categorías de ítem registradas en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual categoría de ítem se quiere consultar. Por ejemplo para consultar desde la categoría 20, se envía start=20.
limit:
integer30
Cantidad de categorías de ítem a partir del inicio que se desea retornar. Por defecto retorna 30 categorías. Si este valor es mayor que 30, la aplicación retorna error.
order_direction:
stringASC
Orden ascendente o descendente en el cual se quieren retornar las categorías. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
order_field:
stringname
Campo por el cual se desea ordenar las categorías de ítem, las opciones posibles son name, id y description.
query:
string
Cadena de texto que se quiere utilizar para buscar las categorías de ítem que en su nombre o descripción contienen dicho texto. Por ejemplo si se desea buscar las categorías de ítem que contengan la palabra cuaderno, se envía query=cuaderno.

Examples


Result Format


Documentation

Endpoint que retorna las categorías de ítem registradas en la cuenta de Alegra. Si no se envía límite de categorías de ítem por defecto se envían 30 categorías de ítem. [block:callout] { "type": "warning", "title": "Atención", "body": "Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error:\n```\n{\n \"code\": 903,\n \"message\" : \"El límite de categorías para retornar debe estar entre 0 y 30\"\n}\n```" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}