Copied!

LocalShippingMethodServiceInterface

LocalShippingMethodServiceInterface.php : 15
Interface
Extends ShippingMethodServiceInterface

Methods

publiccreateShippingMethod()

LocalShippingMethodServiceInterface.php : 21 
public createShippingMethod(ShippingMethodCreateStruct $createStruct) : ShippingMethodInterface

Parameters

Name Type Default value Description
$createStruct ShippingMethodCreateStruct - -

Return values

ShippingMethodInterface

Tags
Throws
InvalidArgumentException
Throws
UnauthorizedException

publicdeleteShippingMethod()

LocalShippingMethodServiceInterface.php : 38 
public deleteShippingMethod(ShippingMethodInterface $shippingMethod) : void

Parameters

Name Type Default value Description
$shippingMethod ShippingMethodInterface - -
Tags
Throws
InvalidArgumentException
Throws
UnauthorizedException

publicdeleteShippingMethodTranslation()

ShippingMethodServiceInterface.php : 73 
public deleteShippingMethodTranslation(ShippingMethodDeleteTranslationStruct $struct) : void

Parameters

Name Type Default value Description
$struct ShippingMethodDeleteTranslationStruct - -

publicfindShippingMethods()

ShippingMethodServiceInterface.php : 43 
public findShippingMethods([ShippingMethodQuery|null $query = null ][, array<string|int, string>|null $prioritizedLanguages = null ]) : ShippingMethodListInterface

Parameters

Name Type Default value Description
$query ShippingMethodQuery|null null -
$prioritizedLanguages array<string|int, string>|null null -

Return values

ShippingMethodListInterface

publicgetShippingMethod()

ShippingMethodServiceInterface.php : 25 
public getShippingMethod(string $identifier[, array<string|int, string>|null $prioritizedLanguages = null ]) : ShippingMethodInterface

Parameters

Name Type Default value Description
$identifier string - -
$prioritizedLanguages array<string|int, string>|null null -

Return values

ShippingMethodInterface

Tags
Throws
NotFoundException

publicgetShippingMethodById()

ShippingMethodServiceInterface.php : 35 
public getShippingMethodById(int $id[, array<string|int, string>|null $prioritizedLanguages = null ]) : ShippingMethodInterface

Parameters

Name Type Default value Description
$id int - -
$prioritizedLanguages array<string|int, string>|null null -

Return values

ShippingMethodInterface

Tags
Throws
NotFoundException

publicisShippingMethodUsed()

ShippingMethodServiceInterface.php : 75 
public isShippingMethodUsed(ShippingMethodInterface $shippingMethod) : bool

Parameters

Name Type Default value Description
$shippingMethod ShippingMethodInterface - -

Return values

bool

publicnewShippingMethodCreateStruct()

LocalShippingMethodServiceInterface.php : 42 
public newShippingMethodCreateStruct(string $identifier) : ShippingMethodCreateStruct

Parameters

Name Type Default value Description
$identifier string - -

Return values

ShippingMethodCreateStruct

publicnewShippingMethodUpdateStruct()

LocalShippingMethodServiceInterface.php : 46 
public newShippingMethodUpdateStruct() : ShippingMethodUpdateStruct

Return values

ShippingMethodUpdateStruct

publicupdateShippingMethod()

LocalShippingMethodServiceInterface.php : 29 
public updateShippingMethod(ShippingMethodInterface $shippingMethod, ShippingMethodUpdateStruct $updateStruct) : ShippingMethodInterface

Parameters

Name Type Default value Description
$shippingMethod ShippingMethodInterface - -
$updateStruct ShippingMethodUpdateStruct - -

Return values

ShippingMethodInterface

Tags
Throws
InvalidArgumentException
Throws
UnauthorizedException