Skip to main content
GET
La Pyme SDK

Authorizations

Authorization
string
header
required

Incluí tu API key en el header Authorization con el prefijo Bearer.

Query Parameters

warehouse_id
string<uuid>
required

ID del depósito a consultar

cursor
string

Valor de next_cursor recibido en la respuesta anterior

limit
integer
default:50

Cantidad máxima de resultados por respuesta

Required range: 1 <= x <= 100
query
string

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

Alias de query

category_ids
string<uuid>[]

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

product_types
enum<string>[]

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

Available options:
product,
combo,
kit,
service
available_rule
enum<string>

Regla para el filtro de stock disponible

Available options:
equal,
between
available_amount
number

Cantidad exacta cuando availableRule=equal

available_min
number

Cantidad mínima cuando availableRule=between

available_max
number

Cantidad máxima cuando availableRule=between

on_hand_rule
enum<string>

Regla para el filtro de stock físico

Available options:
equal,
between
on_hand_amount
number

Cantidad exacta cuando onHandRule=equal

on_hand_min
number

Cantidad mínima cuando onHandRule=between

on_hand_max
number

Cantidad máxima cuando onHandRule=between

reserved_rule
enum<string>

Regla para el filtro de stock reservado

Available options:
equal,
between
reserved_amount
number

Cantidad exacta cuando reservedRule=equal

reserved_min
number

Cantidad mínima cuando reservedRule=between

reserved_max
number

Cantidad máxima cuando reservedRule=between

incoming_rule
enum<string>

Regla para el filtro de stock entrante

Available options:
equal,
between
incoming_amount
number

Cantidad exacta cuando incomingRule=equal

incoming_min
number

Cantidad mínima cuando incomingRule=between

incoming_max
number

Cantidad máxima cuando incomingRule=between

Response

Inventario obtenido exitosamente

request_id
string
required
data
object
required
has_more
boolean
required
next_cursor
string | null
required
object
enum<string>
required

List-envelope discriminator.

Available options:
list
url
string
required

Requested list path.