Skip to main content
ProductsVersion: v3

List Products

GET/products

The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:products.readonly
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

limitnumber

The maximum number of items to be included in a single page of results

Default:0
Example:20
offsetnumber

The starting index of the page, indicating the position from which the results should be retrieved.

Default:0
Example:0
locationIdstringrequired

LocationId is the id of the sub-account

Example:3SwdhCu3svxI8AKsPJt6
searchstring

The name of the product for searching.

Example:Awesome product
collectionIdsstring

Filter by product category Ids. Supports comma separated values

collectionSlugstring

The slug value of the collection by which the collection would be searched

expandstring[]

Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes

productIdsstring[]

List of product ids to be fetched.

storeIdstring

fetch and project products based on the storeId

Example:3SwdhCu3svxI8AKsPJt6
includedInStoreboolean

Separate products by which are included in the store and which are not

Example:true
availableInStoreboolean

If the product is included in the online store

Example:true
sortOrderstring

The order of sort which should be applied for the date

Available optionsascdesc
Example:desc

Response

Successful response

productsobject[]required

An array of products

totalobject[]required

list products status