Get Product List

GET {{baseUrl}}/product.list.json?start=<integer>&count=<integer>&params=<string>&exclude=<string>&category_id=<string>&created_from=<string>&created_to=<string>&modified_from=<string>&modified_to=<string>&avail_view=<boolean>&avail_sale=<boolean>&store_id=<string>&lang_id=<string>&currency_id=<string>&product_ids=<string>&product_variant_params=<string>&since_id=<integer>&report_request_id=<string>&disable_report_cache=<boolean>&sort_by=<string>&sort_direction=<string>&sku=<string>&disable_cache=<boolean>

Get list of products from your store. Returns 10 products by default.

Request Params

KeyDatatypeRequiredDescription
startstringThis parameter sets the number from which you want to get entities
countstringThis parameter sets the entity amount that has to be retrieved. Max allowed count=250
paramsstringSet this parameter in order to choose which entity fields you want to retrieve
excludestringSet this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all
category_idstringRetrieves products specified by category id
created_fromstringRetrieve entities from their creation date
created_tostringRetrieve entities to their creation date
modified_fromstringRetrieve entities from their modification date
modified_tostringRetrieve entities to their modification date
avail_viewstringSpecifies the set of visible/invisible products
avail_salestringSpecifies the set of available/not available products for sale
store_idstringDefines store id where the webhook should be assigned
lang_idstringLanguage id
currency_idstringCurrency Id
product_idsstringRetrieves products specified by product ids
product_variant_paramsstringSet this parameter in order to choose which product variants fields you want to retrieve
since_idstringRetrieve products starting from the specified product id
report_request_idstringReport request id
disable_report_cachestringDisable report cache for current request
sort_bystringSet field to sort by
sort_directionstringSet sorting direction
skustringFilter by product's sku
disable_cachestringDisable cache for current request