Listar Productos

Descripción

Devuelve la lista de productos registrados en el sistema, permitiendo filtrado por diversos campos como ID, nombre, filial, código, si es vendible y estado (activo/inactivo). Los resultados pueden paginarse mediante los parámetros take y skip.

OBS. Disponible para uso con clave de acceso de filial y también con clave de acceso de ADM General.

🔑 Parámetros de Consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
idProduct	int32	No	Filtrar por ID específico del producto.
idBranch	int32	No	Filtrar por número de filial (solo aplicable para claves multilocal; ignorado en caso contrario).
name	string	No	Filtrar por nombre del producto.
code	string	No	Filtrar por código del producto.
onlySellable	boolean	No	Filtrar para devolver solo productos vendibles (`true`). Valor por defecto: `true`.
active	boolean	No	Filtrar para devolver solo productos activos (`true`) o inactivos (`false`). Valor por defecto: `false`.
take	int32	No	Cantidad de registros a devolver (máximo 50). Valor por defecto: 25.
skip	int32	No	Cantidad de registros a omitir en la lista (paginación). Valor por defecto: 0.

📤 Estructura de la Respuesta

La respuesta devuelve la lista de productos encontrados según los filtros indicados.

Campo	Tipo	Descripción
`idProduct`	int32	Identificador único del producto.
`nameProduct`	string	Nombre del producto.
`value`	number	Valor del producto.
`code`	string	Código del producto.
`active`	boolean	Indica si el producto está activo en el sistema.
`sellable`	boolean	Indica si el producto puede ser vendido.
`productForSale`	boolean	Indica si el producto está configurado para la venta.
`allowSaleWithoutStock`	boolean	Indica si el producto puede venderse incluso sin stock disponible.
`currentAmount`	int32	Cantidad actual del producto en stock.
`minimumAmount`	int32	Cantidad mínima configurada para el stock del producto.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "idProduct": 0,
        "nameProduct": "string",
        "value": 0,
        "code": "string",
        "active": true,
        "sellable": true,
        "productForSale": true,
        "allowSaleWithoutStock": true,
        "currentAmount": 0,
        "minimumAmount": 0
    }
]

🟠400Bad Request

Get products

Listar Productos#

Descripción#

🔑 Parámetros de Consulta (Query Params)#