List Products

Description

Returns the list of products registered in the system, allowing filtering by various fields such as ID, name, branch, code, whether it is sellable, and status (active/inactive). The results can be paginated using the take and skip parameters.

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Query Parameters

Parameter	Type	Required	Description
idProduct	int32	No	Filter by specific product ID.
idBranch	int32	No	Filter by branch number (only applicable for multi-location keys; ignored otherwise).
name	string	No	Filter by product name.
code	string	No	Filter by product code.
onlySellable	boolean	No	Filter to return only sellable products (`true`). Default value: `true`.
active	boolean	No	Filter to return only active (`true`) or inactive (`false`) products. Default value: `false`.
take	int32	No	Number of records to return (maximum 50). Default: 25.
skip	int32	No	Number of records to skip in the listing (pagination). Default: 0.

📤 Response Structure

The response returns the list of products found based on the provided filters.

Field	Type	Description
`idProduct`	int32	Unique identifier of the product.
`nameProduct`	string	Name of the product.
`value`	number	Value of the product.
`code`	string	Code of the product.
`active`	boolean	Indicates if the product is active in the system.
`sellable`	boolean	Indicates if the product can be sold.
`productForSale`	boolean	Indicates if the product is configured for sale.
`allowSaleWithoutStock`	boolean	Indicates if the product can be sold even without available stock.
`currentAmount`	int32	Current quantity of the product in stock.
`minimumAmount`	int32	Minimum quantity configured for the product's stock.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

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

🟠400Bad Request

Get products

List Products#

Description#

🔑 Query Parameters#