{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/items/","auth":"required","settings":"","results":{"codes":[{"language":"json","name":"Ejemplo consulta exitosa","status":200,"code":"[\n {\n \"id\": 1,\n \"name\": \"Billetera\",\n \"description\": \"Billetera de cuero negro\",\n \"reference\": \"REF-005\",\n \"inventory\": {\n \"unit\" : \"piece\",\n \"availableQunatity\" : 150,\n \"unitCost\" : 560,\n \"initialQuantity\" : 320\n },\n \"tax\" : [\n {\n \"id\" : 6,\n \"name\" : \"IVA\",\n \"percentage\" : 16,\n \"description\" : \"Impuesto de valor agregado\"\n }\n ],\n \"category\" : {\n \"id\": 54,\n \"name\" : \"Ventas\"\n },\n \"price\" : [\n {\n \"idPriceList\" : 1,\n \"name\" : \"General\",\n \"price\" : 1200\n },\n {\n \"idPriceList\" : 2,\n \"name\" : \"Distribuidor\",\n \"price\" : 1050\n }\n ]\n \n },\n {\n \"id\": 2,\n \"name\": \"Cartera\",\n \"description\": \"Cartera de cuero color café\",\n \"reference\": \"CAR-195\",\n \"inventory\": {\n \"unit\" : \"piece\",\n \"availableQunatity\" : 160,\n \"unitCost\" : 2560,\n \"initialQuantity\" : 120\n },\n \"tax\" : [\n {\n \"id\" : 6,\n \"name\" : \"IVA\",\n \"percentage\" : 16,\n \"description\" : \"Impuesto de valor agregado\"\n }\n ],\n \"category\" : {\n \"id\": 54,\n \"name\" : \"Ventas\"\n },\n \"price\" : [\n {\n \"idPriceList\" : 1,\n \"name\" : \"General\",\n \"price\" : 1200\n },\n {\n \"idPriceList\" : 2,\n \"name\" : \"Distribuidor\",\n \"price\" : 3900\n },\n {\n \"name\" : \"Mayorista\",\n \"idPriceList\" : 6,\n \"price\" : 3700\n }\n ]\n \n },\n\t\t\t\t\t{\n \"id\": 3,\n \"name\": \"Diseño de monedero \",\n \"description\": \"Diseño de monedero en cuero.\",\n \"reference\": \"\",\n \"tax\" : [\n {\n \"id\" : 6,\n \"name\" : \"IVA\",\n \"percentage\" : 16,\n \"description\" : \"Impuesto de valor agregado\"\n }\n ],\n \"category\" : {\n \"id\": 54,\n \"name\" : \"Ventas\"\n },\n \"price\" : [\n {\n \"idPriceList\" : 1,\n \"name\" : \"General\",\n \"price\" : 1200\n }\n ]\n }\n]"},{"language":"json","code":"{ \n\t\"error\": \"No se encontró en la aplicación el item que se está buscando\" ,\n \"code\" : 404\n}","status":404}]},"examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET https://app.alegra.com/api/v1/items/ -u 'usuario:::at:::alegra.co:mitoken'"}]},"params":[{"name":"start","type":"int","default":"0","desc":"desde cual item se quiere consultar. Por ejemplo para consultar desde el ítem 20, se envía start=20","required":false,"in":"body","ref":"","_id":"56afd9393c70b01700facf25"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de items a partir del inicio que se desea retornar. Por defecto retorna 30 items. Si este valor es mayor que 30, la aplicación retorna error","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d7"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar los ítems. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente)","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d6"},{"name":"order_field","type":"string","default":"name","desc":"Campo por el cual se desea ordenar, las opciones posibles son name, id, reference, description","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d5"},{"name":"query","type":"string","default":"","desc":"de texto que se quiere utilizar para buscar en el nombre y referencia del ítem cuales contienen dicho texto. Por ejemplo si se desea buscar los ítems que comiencen con a , se envía query=a","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d4"}]},"next":{"description":"","pages":[]},"title":"Descripción general","type":"basic","slug":"vendedores","excerpt":"Enpoint /sellers","body":"Un vendedor contiene los siguientes atributos:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Nombre\",\n \"h-1\": \"Tipo\",\n \"h-2\": \"Descripción\",\n \"0-0\": \"id\",\n \"0-1\": \"Integer\",\n \"0-2\": \"Identificador único que representa un vendedor específico. La aplicación lo asigna automáticamente.\",\n \"1-0\": \"name\",\n \"1-1\": \"String\",\n \"1-2\": \"Nombre del vendedor.\",\n \"2-0\": \"identification\",\n \"2-1\": \"String\",\n \"2-2\": \"Número de identificación del vendedor.\",\n \"3-0\": \"observations\",\n \"3-1\": \"String\",\n \"3-2\": \"Observaciones del vendedor.\",\n \"h-3\": \"Ejemplo\",\n \"0-3\": \"2\",\n \"1-3\": \"Carlos Mejía\",\n \"2-3\": \"1.0170.127\",\n \"3-3\": \"Vendedor del almacén del norte\",\n \"4-0\": \"status\",\n \"4-1\": \"String\",\n \"4-2\": \"Estado del vendedor. Las opciones posibles son:\\n* active : El vendedor se encuentra activo.\\n* inactive: El vendedor se encuentra inactivo.\",\n \"4-3\": \"active\"\n },\n \"cols\": 4,\n \"rows\": 5\n}\n[/block]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"573dd7e97fe1642200f2a1af","createdAt":"2016-05-19T15:12:41.935Z","editedParams":true,"project":"56abd2434e4b730d009eb10a","__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Vendedores","slug":"vendedores","order":13,"from_sync":false,"reference":true,"_id":"573dd672b3f88f0e00dcae1c","version":"56abd2434e4b730d009eb10d","createdAt":"2016-05-19T15:06:26.171Z","__v":0,"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","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22","5fc1133c51c8370081b28e2a"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":44,"createdAt":"2016-01-29T20:57:39.712Z"},"user":"56abd213d4432d1900eed227","editedParams2":true,"parentDoc":null,"githubsync":""}
Descripción general
Enpoint /sellers