FeaturedProduct (CDev\FeaturedProducts)
FeaturedProduct represents the presence of the product marked as featured in the certain category
GET
Retrieve featured products by conditions
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>[] array
Sample response
[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}]
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>[] array
Sample response
[{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}]
GET
Retrieve featured product by id
id
integer Required
Id value of the FeaturedProduct object
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
Sample response
{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
id
integer Required
Id value of the FeaturedProduct object
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
Sample response
{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
category
PUT
Update featured product by id
id
integer Required
Id value of the FeaturedProduct object
<XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
id
integer Required
Id value of the FeaturedProduct object
<XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
category
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
Sample response
{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
category
DELETE
Delete featured product by id
id
integer Required
Id value of the FeaturedProduct object
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
Sample response
{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
id
integer Required
Id value of the FeaturedProduct object
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
Sample response
{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
category
POST
Add featured product
<XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
<XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
category
default Success <XLite\Module\CDev\FeaturedProducts\Model\FeaturedProduct>
Sample response
{"id":"integer","orderBy":"integer","product":"<XLite\\Model\\Product>","category":"<XLite\\Model\\Category>"}
id
integer
Product + category link unique id
orderBy
integer
Sort position
product
category