Skip to main content
GET
List products
Returns a paginated product list. Your API key needs the products:list scope.

Headers

string
required
Your API key. You can use Authorization: Api-Key your_key instead.

Query parameters

string
Search text.
integer
default:"1"
One-based page number. Values below 1 are treated as 1.
boolean
Filter by availability.
string
Comma-separated category GUIDs. Invalid GUIDs are ignored.
string
Comma-separated brand GUIDs. Invalid GUIDs are ignored.
string
Filter by barcode.
string
Filter by SKU.
Each page contains up to 25 products.

Request example

Response

price is the list price. sellPrice is the effective price after an active discount, when one applies.
object[]
required
Products on the current page.
integer
required
Current page.
integer
required
Maximum items per page. Always 25.
integer
required
Total matching products.

Errors