Copied!

ShipmentServiceInterface

ShipmentServiceInterface.php : 17

Methods

publiccreateShipment()

ShipmentServiceInterface.php : 38
public createShipment(ShipmentCreateStruct $createStruct) : ShipmentInterface

Parameters

Name Type Default value Description
$createStruct ShipmentCreateStruct - -

Return values

ShipmentInterface

Tags
Throws
InvalidArgumentException
Throws
BadStateException
Throws
UnauthorizedException

publicdeleteShipment()

ShipmentServiceInterface.php : 49
public deleteShipment(ShipmentInterface $shipment) : void

Parameters

Name Type Default value Description
$shipment ShipmentInterface - -
Tags
Throws
UnauthorizedException

publicfindShipments()

ShipmentServiceInterface.php : 31
public findShipments([ShipmentQuery|null $query = null ]) : ShipmentListInterface

Parameters

Name Type Default value Description
$query ShipmentQuery|null null -

Return values

ShipmentListInterface

publicgetShipment()

ShipmentServiceInterface.php : 23
public getShipment(int $id) : ShipmentInterface

Parameters

Name Type Default value Description
$id int - -

Return values

ShipmentInterface

Tags
Throws
NotFoundException
Throws
UnauthorizedException

publicgetShipmentByIdentifier()

ShipmentServiceInterface.php : 29
public getShipmentByIdentifier(string $identifier) : ShipmentInterface

Parameters

Name Type Default value Description
$identifier string - -

Return values

ShipmentInterface

Tags
Throws
NotFoundException
Throws
UnauthorizedException

publicupdateShipment()

ShipmentServiceInterface.php : 44
public updateShipment(ShipmentInterface $shipment, ShipmentUpdateStruct $updateStruct) : ShipmentInterface

Parameters

Name Type Default value Description
$shipment ShipmentInterface - -
$updateStruct ShipmentUpdateStruct - -

Return values

ShipmentInterface

Tags
Throws
BadStateException
Throws
UnauthorizedException