{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/warehouses","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://api.alegra.com/api/v1/warehouses/ -u 'usuario:::at:::alegra.com:mitoken'"}]},"params":[{"name":"start","type":"int","default":"","desc":"Desde cual bodega se quiere consultar. Por ejemplo para consultar desde el registro 20, se envía start=20","required":false,"in":"query","ref":"","_id":"6101d62c8711fd004e6ce551"},{"name":"limit","type":"int","default":"","desc":"Cantidad de registros a partir del inicio que se desea retornar. Por defecto retorna 30 registros. Si este valor es mayor que 30, la aplicación retorna error.","required":false,"in":"query","ref":"","_id":"6101d62c8711fd004e6ce552"},{"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 otro atributo \"data\" en donde se envían las bodegas. Actualmente la información que se envía en metadata incluye el total de bodegas que tiene registrada la empresa.","required":false,"in":"query","ref":"","_id":"6101d62c8711fd004e6ce553"},{"name":"order_field","type":"string","default":"id","desc":"Campo por el cual ordenar. Valores posibles 'name', 'id'","required":false,"in":"query","ref":"","_id":"6101d96691875f006c448bea"},{"name":"order_direction","type":"string","default":"ASC","desc":"ASC o DESC","required":false,"in":"query","ref":"","_id":"6101d96691875f006c448beb"},{"name":"fields","type":"string","default":"","desc":"Campos adicionales para retornar. Se puede enviar los siguientes valores separados por coma: editable,deletable","required":false,"in":"query","ref":"","_id":"6101d96691875f006c448bec"},{"name":"name","type":"string","default":"","desc":"Filtrar bodega por nombre","required":false,"in":"query","ref":"","_id":"6109a8f97c3c13001c1b66cd"},{"name":"status","type":"string","default":"","desc":"Filtrar bodega por estado. Valores permitidos: 'active', 'inactive'","required":false,"in":"query","ref":"","_id":"6109a8f97c3c13001c1b66ce"}],"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n {\n    \"id\": \"1\",\n    \"name\": \"Bodega Norte\",\n    \"observations\": \"Bodega ubicada en la zona norte\",\n    \"isDefault\": true,\n    \"address\": \"Calle principal #45\",\n    \"status\": \"active\"\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  }\n]","name":""}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Consultar todas las bodegas","type":"endpoint","slug":"consultar-todas-las-bodegas","excerpt":"Endpoint que permite consultar las bodegas registradas en la aplicación","body":"","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"58e4167829df0b2f0075087d","createdAt":"2017-04-04T21:56:08.127Z","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","60807d7adc33b10010370740","60d30b1745665d00237faa55","60d30b2efa7b7200235a3c93","61006d2332a29f00801deea2","610d39edae2fc2000f014232"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":49,"createdAt":"2016-01-29T20:57:39.712Z"},"__v":5,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Bodegas","slug":"bodegas","order":15,"from_sync":false,"reference":false,"_id":"58e412a5aa544d1b0005f7da","version":"56abd2434e4b730d009eb10d","createdAt":"2017-04-04T21:39:49.140Z","__v":0,"project":"56abd2434e4b730d009eb10a"},"githubsync":"","user":"56abd213d4432d1900eed227","parentDoc":null}

getConsultar todas las bodegas

Endpoint que permite consultar las bodegas registradas en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer
Desde cual bodega se quiere consultar. Por ejemplo para consultar desde el registro 20, se envía start=20
limit:
integer
Cantidad de registros a partir del inicio que se desea retornar. Por defecto retorna 30 registros. Si este valor es mayor que 30, la aplicación retorna error.
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 otro atributo "data" en donde se envían las bodegas. Actualmente la información que se envía en metadata incluye el total de bodegas que tiene registrada la empresa.
order_field:
stringid
Campo por el cual ordenar. Valores posibles 'name', 'id'
order_direction:
stringASC
ASC o DESC
fields:
string
Campos adicionales para retornar. Se puede enviar los siguientes valores separados por coma: editable,deletable
name:
string
Filtrar bodega por nombre
status:
string
Filtrar bodega por estado. Valores permitidos: 'active', 'inactive'

Examples


Result Format


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 }}