Skip to content

List products

GET
/api/website/products
curl --request GET \
--url 'https://api.petanqueai.com/api/website/products?page=1&limit=20&order=asc&sort=name' \
--header 'x-storefront-token: <x-storefront-token>'

Your sellable products, one page at a time: name, brand, descriptions, images, web price and stock.

Only active products that have a web price (WSF) are listed. Out-of-stock products stay in the list with inStock: false. wsfMinor is the price in kuruş with VAT included; vatBps is the VAT rate inside it (2000 = 20%).

Filter with search (name or barcode) and category; sort by name or price. meta carries total, page and limit (at most 100).

page
Any of:
string
/^-?\d+$/
limit
Any of:
string
/^-?\d+$/
order
string
Allowed values: asc desc
search
string
category
string
>= 1 characters <= 120 characters
sort
string
Allowed values: name price