Skip to main content
GET
List products
Returns a paginated list of the store’s products (the ecommerce catalog), newest first, with shop, currency and category populated. Supports filtering by category, free-text search, exact barcode and stock status. Requires the READ_INVENTORY scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

page
integer
default:1

Page number (1-based).

limit
integer
default:10

Items per page.

category
string

Filter by category ObjectId. Ignored if not a valid ObjectId.

Case-insensitive match against product name or barcode.

barcode
string

Exact barcode match.

stock
string

Stock filter: in, out, or low.

Response

List products — success.

status
integer
required
Example:

200

success
boolean
required
Example:

true

message
string
required
Example:

"List products"

data
object
required
Example: