Retrieve a list of featured products for the home page

Retrieves the collection of Product Compact resources.

Authorizations:Token, JWT

Query Parameters

page	integerDefault: 1The collection page number
itemsPerPage	integer[0 .. 100]Default: 30The number of items per page
pagination	booleanEnable or disable pagination
filter.products	stringFilter for "products" field
filter.categories	stringFilter for "categories" field
filter.outOfStock	booleanFilter for "outOfStock" field
filter.bestsellers	booleanFilter for "bestsellers" field
filter.participateSale	booleanFilter for "participateSale" field
filter.newArrivals	booleanFilter for "newArrivals" field
filter.comingSoon	booleanFilter for "comingSoon" field
filter.substring	stringFilter for "substring" field
order_by.name	stringEnum: "asc""desc"Order rule for "name" field
order_by.price	stringEnum: "asc""desc"Order rule for "price" field
order_by.arrivalDate	stringEnum: "asc""desc"Order rule for "arrivalDate" field
order_by.sales	stringEnum: "asc""desc"Order rule for "sales" field
filter.levelId	integer>= 1Filter for "levelId" field
filter.brandId	integer>= 1Filter for "brandId" field

Responses

200Product Compact collection

Response schema: application/jsonapplication/ld+json

Product Compact collection

Array

sku	string
name	string
cleanUrl	string
briefDescription	string
price	number
requiresShipping	boolean
arrivalDate	integer
amount	integer
images	Array of objects
Array url string width integer height integer alt string
brandName	string
minPurchaseQuantity	integer
stickers	Array of objects
Array label string textColor string bgColor string
marketPrice	number
participateSale	boolean
discountType	stringEnum: "sale_price""sale_percent"
saleValue	number
salePrice	number
variation_bases	Array of integers
main_variation_base	object or null
object null base_id integer name string stats object min_price number max_price number minPrice number maxPrice number product_ids Array of integers baseId integer productIds Array of integers
id	integer>= 1
variationBases	Array of integers
mainVariationBase	object or null
object null base_id integer name string stats object min_price number max_price number minPrice number maxPrice number product_ids Array of integers baseId integer productIds Array of integers

401Unauthorized

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Unauthorized

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null

500Internal error

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Internal error

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null