Products: list
Fetches objects collection.

HTTP Request
GET https://shop.url/webapi/rest/products
Parameters
Parameter	Type	Description
limit	integer	count of fetched objects, default: 10, max: 50
order	string	collection sort field
page	integer	index of requested page, default: 1
offset	integer	starting record index (used instead of page)
filters	string	JSON-ified string with filtering criteria
Sort fields
Parameter	Description
product_id	product identifier
type	type of product:
0 - product,
1 - bundle,
producer_id	producer identifier
group_id	option group identifier the product is bound to
tax_id	tax identifier
unit_id	measurement unit identifier
add_date	product addition date in format
edit_date	last product modification date in format
other_price	price of product in other shops
dimension_w	product package width
dimension_h	product package height
dimension_l	product package length
pkwiu	PKWiU (product quantifier)
loyalty_score	loyalty points gained upon product buying
loyalty_price	product price calculated to loyalty points
in_loyalty	is loyalty enabled for product?
bestseller	is product marked as bestseller?
newproduct	is product marked as new?
vol_weight	gauge product weight
gauge_id	gauge identifier
currency_id	product currency
stock	an associative array with base stock info
stock.stock_id	stock identifier
stock.product_id	product identifier
stock.extended	if enabled, object stock is extended by options group; if disabled: basic stock
stock.price	a price or its difference to the basic stock price (always greater than 0)
stock.active	is stock active?
stock.default	should the stock be selected as default upon selection?
stock.stock	stock availability - if warehouses is enabled field is read only and includes the sum of all warehouses
stock.warehouses	if warehouses is enabled it represents stock availability (keys: warehouse identifiers, values: quantity value)
stock.stock_relative	a stock difference the shop value should be altered. If present, stock is ignored
stock.warn_level	stock availability warning level
stock.sold	sold items count
stock.sold_relative	a sold items difference the shop value should be altered. If present, sold is ignored
stock.code	stock code
stock.ean	stock EAN code
stock.weight	weight
stock.weight_type	a method of weight calculation:
0 - no weight specified,
1 - a new stock weight,
2 - weight will be added to the base weight,
3 - weight will be subtracted from the base weight
stock.availability_id	stock availability identifier
stock.calculated_availability_id	stock availability identifier
stock.delivery_id	stock delivery identifier
stock.gfx_id	an identifier of product stock photo
stock.package	package
stock.price_wholesale	wholesale price first basic stock type
stock.price_special	wholesale price second basic stock type
stock.calculation_unit_id	unit price calculation identifier
stock.calculation_unit_ratio	unit price calculation ratio
stock.historical_lowest_price	price from the last 30 days before the promotion
stock.wholesale_historical_lowest_price	wholesale price first from the last 30 days before the promotion
stock.special_historical_lowest_price	wholesale price second from the last 30 days before the promotion
stock.additional_codes	additional codes
translations	an associative array with object translations; if you want to filter things - you can skip locale subkey
translations.(locale).translation_id	translation identifier
translations.(locale).product_id	product identifier
translations.(locale).name	product name
translations.(locale).short_description	short product description
translations.(locale).description	product description
translations.(locale).active	is product translation active
translations.(locale).isdefault	is product added during the install
translations.(locale).lang_id	language identifier
translations.(locale).seo_title	title displayed in <title> tag
translations.(locale).seo_description	description displayed in meta description tag
translations.(locale).seo_keywords	keywords displayed in meta keywords tag
translations.(locale).seo_url	slug displayed in URL
translations.(locale).permalink	full, direct URL to the product
translations.(locale).order	priority used to calculate upon product list sorting
translations.(locale).main_page (deprecated since 5.22.7)	put product on home page ( since 5.22.7 replace the Recommended Products on the Home Page with any one collection )
translations.(locale).main_page_order (deprecated since 5.22.7)	priority used to calculate upon product list sorting on home page ( since 5.22.7 you can change the order of the products in the collection that is set on the home page )
special_offer (deprecated since 5.24.35)	an associative array with product general special offer information (applies for product itself and all variants that do not have dedicated special offer)
special_offer.promo_id (deprecated since 5.24.35)	promotion identifier
special_offer.date_from (deprecated since 5.24.35)	start of product promotion in format
special_offer.date_to (deprecated since 5.24.35)	end of product promotion in format
special_offer.discount (deprecated since 5.24.35)	discount for the product
special_offer.discount_wholesale (deprecated since 5.24.35)	discount for the product (wholesale)
special_offer.discount_special (deprecated since 5.24.35)	discount for the product (special)
special_offer.discount_type (deprecated since 5.24.35)	a method of special offer calculation:
1 - deprecated (discount by amount, did not applied for variants with dedicated price, product price changes affected discount value)
2 - discount by amount, applies for all types of variants (with dedicated price also), does not change on prices changes
special_offer.condition_type (deprecated since 5.24.35)	defines whether the promotion applies to the entire product (general promotion) or to the defined options
1 - whole product with all options
2 - just defined options
unit_price_calculation	is product unit price calculation enabled?
children	an associative array with product bundle children info
children.id	child identifier
children.bundle_id	product bundle identifier
children.stock_id	stock identifier
children.product_id	product identifier
children.stock	stock availability
children.order	child order
feeds_exludes	array of product feed identifiers
created_at	datetime information on object creation in ISO_8601 format
updated_at	datetime information on latest object modification in ISO_8601 format
Filtering criteria
Parameter	Description
product_id	product identifier
type	type of product:
0 - product,
1 - bundle,
producer_id	producer identifier
group_id	option group identifier the product is bound to
tax_id	tax identifier
category_tree_id	tree category identifier to which the product belongs (allows filtering throughout the subjected category)
unit_id	measurement unit identifier
add_date	product addition date in format
edit_date	last product modification date in format
other_price	price of product in other shops
dimension_w	product package width
dimension_h	product package height
dimension_l	product package length
pkwiu	PKWiU (product quantifier)
loyalty_score	loyalty points gained upon product buying
loyalty_price	product price calculated to loyalty points
in_loyalty	is loyalty enabled for product?
bestseller	is product marked as bestseller?
tags	array of tags identifiers
tag_id	filter products by specific tag identifier(s)
collections	an array of the collection identifiers to which the product belongs
newproduct	is product marked as new?
vol_weight	gauge product weight
gauge_id	gauge identifier
currency_id	product currency
stock	an associative array with base stock info
stock.stock_id	stock identifier
stock.product_id	product identifier
stock.extended	if enabled, object stock is extended by options group; if disabled: basic stock
stock.price	a price or its difference to the basic stock price (always greater than 0)
stock.active	is stock active?
stock.default	should the stock be selected as default upon selection?
stock.stock	stock availability - if warehouses is enabled field is read only and includes the sum of all warehouses
stock.stock_relative	a stock difference the shop value should be altered. If present, stock is ignored
stock.warn_level	stock availability warning level
stock.sold	sold items count
stock.sold_relative	a sold items difference the shop value should be altered. If present, sold is ignored
stock.code	stock code
stock.ean	stock EAN code
stock.weight	weight
stock.weight_type	a method of weight calculation:
0 - no weight specified,
1 - a new stock weight,
2 - weight will be added to the base weight,
3 - weight will be subtracted from the base weight
stock.availability_id	stock availability identifier
stock.calculated_availability_id	stock availability identifier
stock.delivery_id	stock delivery identifier
stock.gfx_id	an identifier of product stock photo
stock.package	package
stock.price_wholesale	wholesale price first basic stock type
stock.price_special	wholesale price second basic stock type
stock.calculation_unit_id	unit price calculation identifier
stock.calculation_unit_ratio	unit price calculation ratio
stock.historical_lowest_price	price from the last 30 days before the promotion
stock.wholesale_historical_lowest_price	wholesale price first from the last 30 days before the promotion
stock.special_historical_lowest_price	wholesale price second from the last 30 days before the promotion
stock.additional_codes	additional codes
translations	an associative array with object translations; if you want to filter things - you can skip locale subkey
translations.(locale).translation_id	translation identifier
translations.(locale).product_id	product identifier
translations.(locale).name	product name
translations.(locale).short_description	short product description
translations.(locale).description	product description
translations.(locale).active	is product translation active
translations.(locale).isdefault	is product added during the install
translations.(locale).lang_id	language identifier
translations.(locale).seo_title	title displayed in <title> tag
translations.(locale).seo_description	description displayed in meta description tag
translations.(locale).seo_keywords	keywords displayed in meta keywords tag
translations.(locale).seo_url	slug displayed in URL
translations.(locale).permalink	full, direct URL to the product
translations.(locale).order	priority used to calculate upon product list sorting
translations.(locale).main_page (deprecated since 5.22.7)	put product on home page ( since 5.22.7 replace the Recommended Products on the Home Page with any one collection )
translations.(locale).main_page_order (deprecated since 5.22.7)	priority used to calculate upon product list sorting on home page ( since 5.22.7 you can change the order of the products in the collection that is set on the home page )
special_offer (deprecated since 5.24.35)	an associative array with product general special offer information (applies for product itself and all variants that do not have dedicated special offer)
special_offer.promo_id (deprecated since 5.24.35)	promotion identifier
special_offer.date_from (deprecated since 5.24.35)	start of product promotion in format
special_offer.date_to (deprecated since 5.24.35)	end of product promotion in format
special_offer.discount (deprecated since 5.24.35)	discount for the product
special_offer.discount_wholesale (deprecated since 5.24.35)	discount for the product (wholesale)
special_offer.discount_special (deprecated since 5.24.35)	discount for the product (special)
special_offer.discount_type (deprecated since 5.24.35)	a method of special offer calculation:
1 - deprecated (discount by amount, did not applied for variants with dedicated price, product price changes affected discount value)
2 - discount by amount, applies for all types of variants (with dedicated price also), does not change on prices changes
special_offer.condition_type (deprecated since 5.24.35)	defines whether the promotion applies to the entire product (general promotion) or to the defined options
1 - whole product with all options
2 - just defined options
special_offer.stocks (deprecated since 5.24.35)	array of stock identifiers
base stock identifier - for special offer on whole product with all options ( condition_type = 1)
defined stocks identifiers - for special offer on defined options ( condition_type = 2)
unit_price_calculation	is product unit price calculation enabled?
children	an associative array with product bundle children info
children.id	child identifier
children.bundle_id	product bundle identifier
children.stock_id	stock identifier
children.product_id	product identifier
children.stock	stock availability
children.order	child order
safety_information	product safety information
safety_information.gpsr_producer_id	producer identifier
safety_information.gpsr_importer_id	importer identifier
safety_information.gpsr_responsible_id	responsible person identifier
safety_information.gpsr_certificates	array of certificates identifiers
created_at	datetime information on object creation in ISO_8601 format
updated_at	datetime information on latest object modification in ISO_8601 format
API Scope
This method requires at least one of the following permissions:

products_delete
products_create
products_read
products_edit
HTTP Request body
This method doesn't expect any request body parameters

HTTP Response body
Upon successful request, the collection of objects is returned according to the following structure:

{
    "count": integer,
    "pages": integer,
    "page": integer,
    "list": [
        Resource
    ]
}
Parameter	Type	Description
count	integer	a count of objects satisfying criteria
pages	integer	count of pages with results
page	integer	number of current page
list	array	a collection of objects
ExamplePHP
try{
    $options = array(
        'entrypoint' => $entrypoint,
        'client_id' => $clientId,
        'client_secret' => $clientSecret,
        'access_token' => $accessToken
    );
    $client = DreamCommerce\ShopAppstoreLib\Client::factory('OAuth', $options);

    $resource = new DreamCommerce\ShopAppstoreLib\Resource\Product($client);
    $result = $resource->get();

    foreach($result as $r){
        printf("#%d - %s\n", $r->product_id, $r->translations->pl_PL->name);
    }
} catch(DreamCommerce\ShopAppstoreLib\Exception\Exception $ex) {
    die($ex->getMessage());