{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/items/","auth":"required","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual producto/servicio se quiere consultar. Por ejemplo para consultar desde el producto/servicio 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"56afd9393c70b01700facf25"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de productos/servicios a partir del inicio que se desea retornar. Por defecto retorna 30 productos/servicios. Si este valor es mayor que 30, la aplicación retorna error.","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d7"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar los productos/servicios. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).","required":false,"in":"query","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":"query","ref":"","_id":"56b0b7da36d2580d002477d5"},{"name":"query","type":"string","default":"","desc":"Cadena de texto que se quiere utilizar para buscar los productos/servicios que en su nombre o referencia contienen dicho texto. Por ejemplo si se desea buscar los productos/servicios que contengan la palabra cuaderno, se envía query=cuaderno.","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d4"},{"name":"metadata","type":"boolean","default":"","desc":"Incluir en los resultados metadatos.  Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo \"metadata\" y otro \"data\" en donde se envían los productos.  Actualmente la información que se envía en metadata incluye el total de productos que tiene registrada la empresa.","required":false,"in":"query","ref":"","_id":"56fae61611e13b170054a886"},{"name":"idWarehouse","type":"int","default":"","desc":"Identificador de bodega/almacén. Si se especifica este parámetro se retornan únicamente los productos no inventariables y los inventariables que estén en la bodega/almacén.","required":false,"in":"query","ref":"","_id":"59499e21b9248d0024fe4117"},{"name":"name","type":"string","default":"","desc":"Filtrar por nombre de item.","required":false,"in":"query","ref":"","_id":"5eeba102491e04062df01a67"},{"name":"reference","type":"string","default":"","desc":"Filtrar por referencia del item.","required":false,"in":"query","ref":"","_id":"5eeba102491e04062df01a66"},{"name":"price","type":"string","default":"","desc":"Filtrar por el precio del item, sin decimales.","required":false,"in":"query","ref":"","_id":"5eeba102491e04062df01a65"},{"name":"description","type":"string","default":"","desc":"Filtrar por la descripción del item.","required":false,"in":"query","ref":"","_id":"5eeba102491e04062df01a64"},{"name":"priceList_id","type":"string","default":"","desc":"Filtrar por el id de la lista de precios.","required":false,"in":"query","ref":"","_id":"5eeba102491e04062df01a63"},{"name":"idItemCategory","type":"int","default":"","desc":"Identificador de categoría de ítem. Si se especifica este parámetro se retornan únicamente los productos asociados a la categoría.","required":false,"in":"query","ref":"","_id":"5efcdb0d1b216d00242396d2"},{"name":"type","type":"string","default":"","desc":"Filtrar por tipo de item, puedes enviar multiples tipos separados por coma. ej: simple,kit,variant","required":false,"in":"query","ref":"","_id":"5efcf8b924e0b5002bdd1387"},{"name":"variantAttribute_id","type":"string","default":"","desc":"Identificador de atributo variante. Si se especifica este parámetro se retornan únicamente los productos que tengan el atributo variante enviado como parámetro.","required":false,"in":"query","ref":"","_id":"5efcf8b924e0b5002bdd1386"},{"name":"variantAttributeOption_id","type":"string","default":"","desc":"Identificador de la opción de un atributo variante. Si se especifica este parámetro se retornan únicamente los productos que tengan la opción enviada como parámetro.","required":false,"in":"query","ref":"","_id":"5efcf8b924e0b5002bdd1385"},{"name":"variantParent_id","type":"string","default":"","desc":"Identificador del item con variantes (item padre). Si se especifica este parámetro se retornan únicamente los productos que sean variantes (hijos) del item padre..","required":false,"in":"query","ref":"","_id":"5efcf8b924e0b5002bdd1384"}],"results":{"codes":[{"name":"Ejemplo consulta exitosa","language":"json","code":"[\n  {\n    \"id\": 1,\n    \"name\": \"Billetera\",\n    \"description\": \"Billetera de cuero negro\",\n    \"reference\": \"REF-005\",\n    \"status\" : \"inactive\",\n    \"inventory\": {\n      \"unit\" : \"piece\",\n      \"availableQuantity\" : 150,\n      \"unitCost\" : 560,\n      \"initialQuantity\" : 320,\n      \"warehouses\" : [\n        {\n          \"id\": \"1\",\n          \"name\": \"Bodega Norte\",\n          \"observations\": null,\n          \"isDefault\": true,\n          \"address\":\"Dirección de la bodega Norte\",\n          \"status\": \"active\",\n          \"initialQuantity\": \"320.0\",\n          \"availableQuantity\": \"150\",\n          \"minQuantity\": \"100\",\n          \"maxQuantity\": \"400\"\n          }\n        ]\n      },\n    \"tax\" : [\n      {\n        \"id\" : 6,\n        \"name\" : \"IVA\",\n        \"percentage\" : 16,\n        \"description\" : \"Impuesto de valor agregado\",\n        \"status\": \"active\"\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    \"id\": 2,\n    \"name\": \"Cartera\",\n    \"description\": \"Cartera de cuero color café\",\n    \"reference\": \"CAR-195\",\n    \"status\" : \"active\",\n    \"inventory\": {\n      \"unit\" : \"piece\",\n      \"availableQuantity\" : 160,\n      \"unitCost\" : 2560,\n      \"initialQuantity\" : 120,\n      \"warehouses\" : [\n        {\n          \"id\": \"1\",\n          \"name\": \"Bodega Norte\",\n          \"observations\": null,\n          \"isDefault\": true,\n          \"address\":\"Dirección de la bodega Norte\",\n          \"status\": \"active\",\n          \"initialQuantity\": \"20.0\",\n          \"availableQuantity\": \"100\",\n          \"minQuantity\": \"10\",\n          \"maxQuantity\": \"120\"\n        },\n        {\n          \"id\": \"3\",\n          \"name\": \"Bodega Sur\",\n          \"observations\": \"Bodega ubicada en la zona sur\",\n          \"isDefault\": false,\n          \"address\": null,\n          \"status\": \"active\",\n          \"initialQuantity\": \"100.0\",\n          \"availableQuantity\": \"600\",\n          \"minQuantity\": \"80\"\n          }\n        ]\n      },\n    \"tax\" : [\n      {\n        \"id\" : 6,\n        \"name\" : \"IVA\",\n        \"percentage\" : 16,\n        \"description\" : \"Impuesto de valor agregado\",\n\t      \"status\": \"active\"\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    \"id\": 3,\n    \"name\": \"Diseño de monedero \",\n    \"description\": \"Diseño de monedero en cuero.\",\n    \"reference\": \"\",\n    \"status\" : \"active\",\n    \"tax\" : [\n      {\n        \"id\" : 6,\n        \"name\" : \"IVA\",\n        \"percentage\" : 16,\n        \"description\" : \"Impuesto de valor agregado\",\n        \"status\": \"active\"\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]","status":200},{"language":"json","status":400,"name":"Bad Request - Límite sobrepasa máximo permitido","code":"{ \n\t\"error\": \"El límite de productos/servicios para retornar debe ser menor o igual a 30\",\n\t\"code\" : 903\n}"},{"code":"{\n  \"metadata\": {\n    \"total\" : 150\n  },\n  \"data\": [\n    {\n      \"id\": 1,\n      \"name\": \"Billetera\",\n      \"description\": \"Billetera de cuero negro\",\n      \"reference\": \"REF-005\",\n      \"status\" : \"inactive\",\n      \"inventory\": {\n        \"unit\" : \"piece\",\n        \"availableQuantity\" : 150,\n        \"unitCost\" : 560,\n        \"initialQuantity\" : 320,\n        \"warehouses\" : [\n          {\n            \"id\": \"1\",\n            \"name\": \"Bodega Norte\",\n            \"observations\": null,\n            \"isDefault\": true,\n            \"address\":\"Dirección de la bodega Norte\",\n            \"status\": \"active\",\n            \"initialQuantity\": \"320.0\",\n            \"availableQuantity\": \"150\",\n\t          \"minQuantity\": \"100\",\n  \t        \"maxQuantity\": \"400\"\n            }\n          ]\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      \"id\": 2,\n      \"name\": \"Cartera\",\n      \"description\": \"Cartera de cuero color café\",\n      \"reference\": \"CAR-195\",\n      \"status\" : \"active\",\n      \"inventory\": {\n        \"unit\" : \"piece\",\n        \"availableQuantity\" : 160,\n        \"unitCost\" : 2560,\n        \"initialQuantity\" : 120,\n        \"warehouses\" : [\n          {\n            \"id\": \"1\",\n            \"name\": \"Bodega Norte\",\n            \"observations\": null,\n            \"isDefault\": true,\n            \"address\":\"Dirección de la bodega Norte\",\n            \"status\": \"active\",\n            \"initialQuantity\": \"20.0\",\n            \"availableQuantity\": \"100\",\n\t          \"minQuantity\": \"10\",\n  \t        \"maxQuantity\": \"120\"\n          },\n          {\n            \"id\": \"3\",\n            \"name\": \"Bodega Sur\",\n            \"observations\": \"Bodega ubicada en la zona sur\",\n            \"isDefault\": false,\n            \"address\": null,\n            \"status\": \"active\",\n            \"initialQuantity\": \"100.0\",\n            \"availableQuantity\": \"600\",\n            \"minQuantity\": \"80\"\n            }\n          ]\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      \"id\": 3,\n      \"name\": \"Diseño de monedero \",\n      \"description\": \"Diseño de monedero en cuero.\",\n      \"reference\": \"\",\n      \"status\" : \"active\",\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  ]\n }","language":"json","status":200,"name":"Consulta exitosa con metadatos"},{"status":404,"language":"json","code":"{\n\t\"code\": 404,\n  \"message\": \"No se encontró la bodega/almacén con id: 9\"\n}"}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://api.alegra.com/api/v1/items/ -u 'usuario:::at:::alegra.com:mitoken'"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Lista de productos","type":"endpoint","slug":"lista-de-productos-o-servicios","excerpt":"Endpoint que permite consultar los productos o servicios registrados en la aplicación","body":"Endpoint que retorna los productos y servicios registrados en la cuenta de Alegra. Si no se envía límite de productos/servicios por defecto se envían 30 productos/servicios.  \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 debe ser menor o igual a 30\\\"\\n}\\n```\"\n}\n[/block]","updates":["5d0ad90ea845c40378614de9"],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56b0b7da36d2580d002477d3","createdAt":"2016-02-02T14:06:18.419Z","project":"56abd2434e4b730d009eb10a","editedParams":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["56d5f18b31857e2500db0d4b"],"title":"Productos o servicios","slug":"productos-o-servicios","order":1,"from_sync":false,"reference":true,"_id":"56b3b8ea9f97020d0012d936","__v":1,"createdAt":"2016-02-04T20:47:38.572Z","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d"},"user":"56abd213d4432d1900eed227","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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":39,"createdAt":"2016-01-29T20:57:39.712Z"},"editedParams2":true,"parentDoc":null,"__v":10}

getLista de productos

Endpoint que permite consultar los productos o servicios registrados en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual producto/servicio se quiere consultar. Por ejemplo para consultar desde el producto/servicio 20, se envía start=20.
limit:
integer30
Cantidad de productos/servicios a partir del inicio que se desea retornar. Por defecto retorna 30 productos/servicios. 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 los productos/servicios. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
order_field:
stringname
Campo por el cual se desea ordenar, las opciones posibles son name, id, reference, description.
query:
string
Cadena de texto que se quiere utilizar para buscar los productos/servicios que en su nombre o referencia contienen dicho texto. Por ejemplo si se desea buscar los productos/servicios que contengan la palabra cuaderno, se envía query=cuaderno.
metadata:
boolean
Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los productos. Actualmente la información que se envía en metadata incluye el total de productos que tiene registrada la empresa.
idWarehouse:
integer
Identificador de bodega/almacén. Si se especifica este parámetro se retornan únicamente los productos no inventariables y los inventariables que estén en la bodega/almacén.
name:
string
Filtrar por nombre de item.
reference:
string
Filtrar por referencia del item.
price:
string
Filtrar por el precio del item, sin decimales.
description:
string
Filtrar por la descripción del item.
priceList_id:
string
Filtrar por el id de la lista de precios.
idItemCategory:
integer
Identificador de categoría de ítem. Si se especifica este parámetro se retornan únicamente los productos asociados a la categoría.
type:
string
Filtrar por tipo de item, puedes enviar multiples tipos separados por coma. ej: simple,kit,variant
variantAttribute_id:
string
Identificador de atributo variante. Si se especifica este parámetro se retornan únicamente los productos que tengan el atributo variante enviado como parámetro.
variantAttributeOption_id:
string
Identificador de la opción de un atributo variante. Si se especifica este parámetro se retornan únicamente los productos que tengan la opción enviada como parámetro.
variantParent_id:
string
Identificador del item con variantes (item padre). Si se especifica este parámetro se retornan únicamente los productos que sean variantes (hijos) del item padre..

Examples


Result Format


Documentation

Endpoint que retorna los productos y servicios registrados en la cuenta de Alegra. Si no se envía límite de productos/servicios por defecto se envían 30 productos/servicios. [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 debe ser menor o igual a 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 }}