TrackingCodeRepository
in
Interface TrackingCodeRepository
Table of Contents
- createMultipleTrackingCodes() : TrackingCodeIds
- Creates multiple tracking codes and returns their IDs.
- createTrackingCode() : TrackingCodeId
- Creates a new tracking code and returns its ID.
- deleteTrackingCodes() : void
- Deletes tracking codes based on the given IDs.
- filterTrackingCodes() : TrackingCodes
- Returns a filtered and paginated collection of tracking codes based on the given filter and sorting arguments.
- getAllTrackingCodes() : TrackingCodes
- Returns all available tracking codes.
- getTrackingCodeById() : TrackingCode
- Returns a specific tracking code by its ID.
- getTrackingCodesByOrderId() : TrackingCodes
- Returns all tracking code, that belong to a specific order ID.
- getTrackingCodesTotalCount() : int
- Returns total count of tracking codes based on the given filter arguments.
Methods
createMultipleTrackingCodes()
Creates multiple tracking codes and returns their IDs.
public
createMultipleTrackingCodes(array<string|int, mixed> ...$creationArguments) : TrackingCodeIds
Parameters
- $creationArguments : array<string|int, mixed>
-
Provided array must contain arguments like they are used in the single creation method. Provide multiple arrays for multi creation.
Tags
Return values
TrackingCodeIds —createTrackingCode()
Creates a new tracking code and returns its ID.
public
createTrackingCode(OrderId $orderId, string $code, ParcelServiceDetails $parcelServiceDetails, bool $isReturnDelivery) : TrackingCodeId
Parameters
- $orderId : OrderId
- $code : string
- $parcelServiceDetails : ParcelServiceDetails
- $isReturnDelivery : bool
Tags
Return values
TrackingCodeId —deleteTrackingCodes()
Deletes tracking codes based on the given IDs.
public
deleteTrackingCodes(TrackingCodeId ...$ids) : void
Parameters
- $ids : TrackingCodeId
Tags
Return values
void —filterTrackingCodes()
Returns a filtered and paginated collection of tracking codes based on the given filter and sorting arguments.
public
filterTrackingCodes(Filters $filters, Sorting $sorting, Pagination $pagination) : TrackingCodes
Parameters
- $filters : Filters
- $sorting : Sorting
- $pagination : Pagination
Return values
TrackingCodes —getAllTrackingCodes()
Returns all available tracking codes.
public
getAllTrackingCodes() : TrackingCodes
Return values
TrackingCodes —getTrackingCodeById()
Returns a specific tracking code by its ID.
public
getTrackingCodeById(TrackingCodeId $id) : TrackingCode
Parameters
- $id : TrackingCodeId
Tags
Return values
TrackingCode —getTrackingCodesByOrderId()
Returns all tracking code, that belong to a specific order ID.
public
getTrackingCodesByOrderId(OrderId $orderId) : TrackingCodes
Parameters
- $orderId : OrderId
Return values
TrackingCodes —getTrackingCodesTotalCount()
Returns total count of tracking codes based on the given filter arguments.
public
getTrackingCodesTotalCount(Filters $criteria) : int
Parameters
- $criteria : Filters