Listar depósitos
https://carchost.fieldcontrol.com.br/storages-v2Lista los depósitos de la cuenta, con paginación, filtros y ordenación. El listado no incluye storageProducts. Requiere el módulo de control de inventario.
Requiere los headers
X-Api-KeyyUser-Agent. Límite: 1 solicitud por segundo (más información).
Solicitud
Parámetros de consulta
limitintegerCantidad de ítems por página.
De 1 a 100.Predeterminado: 10.
offsetintegerCantidad de ítems que se omiten.
De 0 a 200000.Predeterminado: 0.
qstringFiltros en el formato campo:valor, separados por espacios (cómo filtrar). Los filtros aceptados están en la tabla de abajo.
Ejemplo: name:central archived:false.
| Filtro | Qué hace |
|---|---|
name | Parte del nombre del depósito, sin distinguir mayúsculas y minúsculas. Hasta 50 caracteres. |
name_eq | Nombre del depósito, exactamente igual al registrado. Hasta 50 caracteres. |
description | Parte de la descripción, sin distinguir mayúsculas y minúsculas. Hasta 100 caracteres. |
employee_id | Identificador del colaborador responsable. |
archived |
|
sortstringOrdenación. El prefijo - invierte el orden.
Valores aceptados: id, created_at, -created_at.Predeterminado: id.
Headers
User-AgentstringobligatorioIdentificación de su aplicación.
Ejemplo: MinhaIntegracao/1.0.
Respuestas
- 200
Lista de depósitos.
- 401
Clave de API ausente (
Missing API Key) o inválida (Invalid API Key). Consulte Autenticación. - 403
Cuenta bloqueada (
Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación. - 422
Filtro, paginación u ordenación inválidos (parametersValidationErr). Cuenta sin el módulo de control de inventario: resourceNotAllowed.
- 429
Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.
- 500
Error inesperado en el servidor.