When you work with your Commerce implementation, you can review and modify the checkout configuration.
When you modify the workflow configuration, make sure you properly set user permissions to the checkout component.
Checkout workflow relies on Symfony Workflow. Each transition represents a separate checkout step.
By default, the checkout process is configured to render each step based on a separate set of libraries and templates. Each checkout step is handled by a controller that you configure in workflow metadata.
Custom workflow implementations are defined under the
and they must support the
The default fallback workflow is
ibexa_checkout, which is prepended at bundle level.
checkout.workflow parameter is repository-aware.
To customize your configuration, place it in a YAML file, under the
framework.workflows.<your_workflow_name> key, and reference it with
The system can then identify which of your configured workflows handles the checkout process.
When you modify or create a controller, to ensure that no user data is lost, extend the
Ibexa\Bundle\Checkout\Controller\AbstractStep controller and call the
Each step configuration includes the following settings:
controller- A mandatory setting pointing to a library that governs the behavior of the process. The controller contains all the required business logic and submits the whole step, so that a transition can happen.
next_step- An optional name of the next workflow transition. If not provided, the next workflow-enabled transition is processed.
label- An optional name of the step that can be displayed in the Twig helper.
translation_domain- A optional setting that defines the domain for a site with translated content. By default it is set to
Default checkout workflow configuration¶
The default checkout workflow configuration looks as follows.
ibexa_checkout key is used by default, you can replace it with your custom workflow identifier if needed.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
Configure shipping and payment methods¶
You can define the shipping and payment methods.
ibexa.repositories.<repository_name>.checkout, create entries that resemble
the following example.
If you do not set a value for the
ibexa_checkout is used by default.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
Shipping and billing address field format configuration¶
In your implementation, you may need to create custom format configurations for the shipping or billing address fields, for example, to use different address formats based on the buyer's geographical location.
Field formats for the billing and shipping addresses comply with the FieldType Address specification and can be controlled with the
shipping_address_format flags, respectively.
They fall back to
shipping predefined formats by default:
billingis part of the
shippingis part of the
ibexa/checkoutbundle's default configuration
To modify address formats you create custom ones.
You can customize the checkout process to make it fit your specific needs. For more information, see Customize checkout.