Copied!

OrderServiceInterface

OrderServiceInterface.php : 17

Methods

publiccancelOrder()

OrderServiceInterface.php : 40
public cancelOrder(OrderInterface $order) : void

Parameters

Name Type Default value Description
$order OrderInterface - -
Tags
Throws
InvalidArgumentException
Throws
UnauthorizedException
Throws
NotFoundException
Throws
ValidationFailedExceptionInterface

publiccreateOrder()

OrderServiceInterface.php : 24
public createOrder(OrderCreateStruct $createStruct) : OrderInterface

Parameters

Name Type Default value Description
$createStruct OrderCreateStruct - -

Return values

OrderInterface

Tags
Throws
InvalidArgumentException
Throws
UnauthorizedException
Throws
ValidationFailedExceptionInterface

publicfindOrders()

OrderServiceInterface.php : 54
public findOrders([OrderQuery|null $orderQuery = null ]) : OrderListInterface

Parameters

Name Type Default value Description
$orderQuery OrderQuery|null null -

Return values

OrderListInterface

publicgetOrder()

OrderServiceInterface.php : 46
public getOrder(int $id) : OrderInterface

Parameters

Name Type Default value Description
$id int - -

Return values

OrderInterface

Tags
Throws
UnauthorizedException
Throws
NotFoundException

publicgetOrderByIdentifier()

OrderServiceInterface.php : 52
public getOrderByIdentifier(string $identifier) : OrderInterface

Parameters

Name Type Default value Description
$identifier string - -

Return values

OrderInterface

Tags
Throws
UnauthorizedException
Throws
NotFoundException

publicupdateOrder()

OrderServiceInterface.php : 32
public updateOrder(OrderInterface $order, OrderUpdateStruct $updateStruct) : OrderInterface

Parameters

Name Type Default value Description
$order OrderInterface - -
$updateStruct OrderUpdateStruct - -

Return values

OrderInterface

Tags
Throws
InvalidArgumentException
Throws
UnauthorizedException
Throws
NotFoundException
Throws
ValidationFailedExceptionInterface