Skip to main content

Products

Get All Products​

Retrieve a paginated list of products.

GET /products

Query Parameters​

ParameterTypeDefaultDescription
pageinteger1Page number
limitinteger20Products per page
orderBystringnameField to sort by
orderstringascSort order (asc/desc)

Response​

{
"page": 1,
"limit": 20,
"totalProducts": 1000,
"totalPages": 100,
"data": [
{
"name": "product name",
"barcode": "barcode",
"category": "product category",
"image": "product image",
"retailer_prices": [
{
"merchant_name": "merchant name",
"price": 10,
"price_normalized": 10
},
]
}
]
}

Search Products​

Search products by name (case-insensitive, accent-insensitive).

GET /products/search?q=your+query

Query Parameters​

ParameterTypeRequiredDescription
qstringYesSearch query

Response​

{
"count": 100,
"data": [...]
}

Products by Category​

GET /products/category/:category_name

Response​

{
"category": "category name",
"count": 100,
"results": [...]
}

Products by Merchant​

GET /products/merchant/:merchant_name

Response​

{
"merchant": "merchant name",
"count": 100,
"results": [
{
"name": "product name",
"category": "category",
"price": 10
}
]
}