API Documentation
Back to top  

ParcelServiceReadServiceInterface

Extends

Interface ParcelServiceReadService

package

Default

Methods

Returns a limited collection of parcel services.

getAll(\Pager|null $pager = null, array $sorters = array()) : \ParcelServiceCollection

Arguments

$pager

\Pager|null

(Optional) Pager object with pagination information

$sorters

array

(Optional) array of Sorter objects with data sorting information

Response

\ParcelServiceCollection

Returns a collection of parcel services found be the given limited search condition.

getBy(\ParcelServiceSearchCondition $searchCondition, \Pager|null $pager = null, array $sorters = array()) : \ParcelServiceCollection

Arguments

$searchCondition

\ParcelServiceSearchCondition

$pager

\Pager|null

(Optional) Pager object with pagination information

$sorters

array

(Optional) array of Sorter objects with data sorting information

Response

\ParcelServiceCollection

Returns a parcel service identified by its ID.

getById(\ParcelServiceId $parcelServiceId) : \ParcelServiceInterface

Arguments

$parcelServiceId

\ParcelServiceId

Response

\ParcelServiceInterface