EcommerceProducts

Return all your products

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

limitlongOptionalDefaults to 50
Number of documents per page
offsetlongOptionalDefaults to 0
Index of the first document in the page
sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:
idslist of stringsOptional
Filter by product ids
namestringOptional
Filter by product name, minimum 3 characters should be present for search.
price[lte]doubleOptional
Price filter for products less than and equals to particular amount
price[gte]doubleOptional
Price filter for products greater than and equals to particular amount
price[lt]doubleOptional
Price filter for products less than particular amount
price[gt]doubleOptional
Price filter for products greater than particular amount
price[eq]doubleOptional
Price filter for products equals to particular amount
price[ne]doubleOptional
Price filter for products not equals to particular amount
categorieslist of stringsOptional
Filter by categories ids
modifiedSincestringOptional

Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

createdSincestringOptional

Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

isDeletedstringOptional

Filter products by their deletion status. If false is passed, only products that are not deleted will be returned.

Response

All products listed
countlong
Number of products
productslist of objects

Errors