Depósitos

Listar depósitos

Lista los depósitos con búsqueda por código, nombre, calle, localidad o código postal y filtro de estado.

GET/api/v1/warehouses/list

Permiso: warehouses.view
Empresa: Opera sobre la empresa activa
Tipo: Lectura: no cambia nada
Respuesta: JSON

Encabezados

Cookietextorequerido
La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.
X-Expected-Companyuuidrequerido
La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Parámetros de la consulta

searchtextoadmite null
hasta 80 caracteres
statusopción
Valores: active inactive allPor defecto: active
pageentero
Por defecto: 1mínimo 1
pageSizeentero
Por defecto: 50mínimo 1, máximo 100

Respuesta

200 con este JSON.

warehouseslista de objetorequerido
Campos de cada elemento (8)
- iduuidrequerido
- codetextorequerido
- nametextorequerido
- addresscualquierarequerido
- isGeneralsí o norequerido
- statustextorequerido
- versionenterorequerido
  mínimo 1
- activeLocationsenterorequerido
  mínimo 0
totalenterorequerido
mínimo 0

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

`401`	Falta la credencial o venció.
`403`	La credencial no tiene el permiso `warehouses.view`.
`409`	La empresa activa no es la de `X-Expected-Company`.
`422`	Datos inválidos o una regla de negocio rota, con el detalle por campo.
`503`	Sistema ocupado: reintentá después de `Retry-After` segundos.

La lista completa está en Errores.

curl
TypeScript

curl "$ERP_URL/api/v1/warehouses/list" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/warehouses/list`, {
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
  },
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "warehouses": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "code": "texto",
      "name": "texto",
      "address": null,
      "isGeneral": false,
      "status": "texto",
      "version": 1,
      "activeLocations": 1
    }
  ],
  "total": 1
}