API Documentation
Back to top  

SpecialOfferReadServiceInterface

Extends

Interface SpecialOfferReadServiceInterface

package

Default

Methods

Returns all special offers.

getAll(\Pager $pager) : \SpecialOfferCollection

Arguments

$pager

\Pager

Pager instance that stores the current page and items per page.

Response

\SpecialOfferCollection

List of special offers.

Returns all special offers that matches the given search condition.

getBy(\Pager $pager, \SpecialOfferSearchCondition $searchCondition) : \SpecialOfferCollection

Arguments

$pager

\Pager

Pager instance that stores the current page and items per page.

$searchCondition

\SpecialOfferSearchCondition

Condition that must match for found items.

Response

\SpecialOfferCollection

List of special offers by given conditions.

Returns a special offer by the given id.

getById(\SpecialOfferIdInterface $specialOfferId) : \SpecialOfferInterface
Throws
\SpecialOfferNotFoundException

Arguments

$specialOfferId

\SpecialOfferIdInterface

Id of expected special offer.

Response

\SpecialOfferInterface

Special offer entity by given id.