Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.84 KB

shipping_method_api.md

File metadata and controls

71 lines (46 loc) · 2.84 KB
Raw
description edition
Use PHP API to manage shipping methods in Commerce. Create and update shipping methods, delete shipping methods and their translations.
commerce

Shipping method API

To get shipping methods and manage them, use the Ibexa\Contracts\Shipping\ShippingMethodServiceInterface interface.

Shipping methods are referenced with identifiers defined manually at method creation stage in user interface.

Get shipping method

Get shipping method by identifier

To access a shipping method by using its identifier, use the ShippingMethodServiceInterface::getShippingMethod method. The method takes a string as $identifier parameter and uses a prioritized language from SiteAccess settings unless you pass another language as forcedLanguage.

[[= include_file('code_samples/api/commerce/src/Command/ShippingMethodCommand.php', 61, 71) =]]

Get shipping method by ID

To access a shipping method by using its ID, use the ShippingMethodServiceInterface::getShippingMethod method. The method takes a string as $id parameter and uses a prioritized language from SiteAccess settings unless you pass another language as forcedLanguage.

[[= include_file('code_samples/api/commerce/src/Command/ShippingMethodCommand.php', 49, 59) =]]

Get multiple shipping methods

To fetch multiple shipping methods, use the ShippingMethodServiceInterface::getShippingMethod method. It follows the same search query pattern as other APIs:

[[= include_file('code_samples/api/commerce/src/Command/ShippingMethodCommand.php', 73, 91) =]]

Create shipping method

To create a shipping method, use the ShippingMethodServiceInterface::createShippingMethod method and provide it with the Ibexa\Contracts\Shipping\Value\ShippingMethodCreateStruct object that you created by using the newShippingMethodCreateStruct method.

[[= include_file('code_samples/api/commerce/src/Command/ShippingMethodCommand.php', 92, 116) =]]

Update shipping method

To update a shipping method, use the ShippingMethodServiceInterface::updateShippingMethod method and provide it with the Ibexa\Contracts\Shipping\Value\ShippingMethodUpdateStruct object that you created by using the newShippingMethodUpdateStruct method.

[[= include_file('code_samples/api/commerce/src/Command/ShippingMethodCommand.php', 118, 133) =]]

Delete shipping method

To update a shipping method, use the ShippingMethodServiceInterface::deleteShippingMethod method.

[[= include_file('code_samples/api/commerce/src/Command/ShippingMethodCommand.php', 134, 140) =]]

Delete shipping method translation

To delete shipping method translation, use the ShippingMethodServiceInterface::deleteShippingMethodTranslation method.

[[= include_file('code_samples/api/commerce/src/Command/ShippingMethodCommand.php', 142, 151) =]]