v1

latestOpenAPI 3.1.0Proprietary2026-07-22134294785.0 KB

API

Consultar inventario por depósito

Devuelve el inventario de un depósito específico con filtros por categoría, tipo y cantidades.

get/api/v1/inventory

Query parameters

warehouse_idstring uuid required

ID del depósito a consultar

cursorstring

Valor de next_cursor recibido en la respuesta anterior

limitinteger

Cantidad máxima de resultados por respuesta

querystring

Texto de búsqueda por producto, SKU, código de barras o variante

searchstring

Alias de query

category_idsstring[]

IDs de categorías. Puede repetirse o enviarse separada por comas.

product_typesApiSharedEnum5c962a8637[]

Tipos de producto. Puede repetirse o enviarse separada por comas.

available_rule'equal' | 'between'

Regla para el filtro de stock disponible

available_amountnumber

Cantidad exacta cuando availableRule=equal

available_minnumber

Cantidad mínima cuando availableRule=between

available_maxnumber

Cantidad máxima cuando availableRule=between

on_hand_rule'equal' | 'between'

Regla para el filtro de stock físico

on_hand_amountnumber

Cantidad exacta cuando onHandRule=equal

on_hand_minnumber

Cantidad mínima cuando onHandRule=between

on_hand_maxnumber

Cantidad máxima cuando onHandRule=between

reserved_rule'equal' | 'between'

Regla para el filtro de stock reservado

reserved_amountnumber

Cantidad exacta cuando reservedRule=equal

reserved_minnumber

Cantidad mínima cuando reservedRule=between

reserved_maxnumber

Cantidad máxima cuando reservedRule=between

incoming_rule'equal' | 'between'

Regla para el filtro de stock entrante

incoming_amountnumber

Cantidad exacta cuando incomingRule=equal

incoming_minnumber

Cantidad mínima cuando incomingRule=between

incoming_maxnumber

Cantidad máxima cuando incomingRule=between

Response

Inventario obtenido exitosamente

request_idstring required

has_moreboolean required

next_cursorstring nullable required

object'list' required

List-envelope discriminator.

urlstring required

Requested list path.