How to Get Order Custom Field Value on Order Confirmation Email Template in Shopware 6
As a developer you’re likely familiar with the nuances of handling events within an e-commerce platform like Shopware 6. However, when working with custom fields and ensuring that the fields appear in the order confirmation email, there is a problem that fields saved within CheckoutOrderPlacedEvent do not appear. Sometimes this can be irritating though there is a simple way of dealing with it.
Why CartConvertedEvent in Shopware 6?
In Shopware 6, there is the CheckoutOrderPlacedEvent is triggered after an order has been placed, any fields saved then, are as well too late to be included in the order confirmation email. On the other hand, the CartConvertedEvent is triggered before the order is placed, ensuring that custom fields are saved to the order in time to be included in the email.
Steps to Implement the Solution in Shopware 6
1. Create a Subscriber for CartConvertedEvent: You need to listen to the CartConvertedEvent and save the custom fields at this stage.
php
| 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 | namespace YourNamespace\EventSubscriber; use Shopware\Core\Checkout\Cart\Event\CartConvertedEvent; use Symfony\Component\EventDispatcher\EventSubscriberInterface; class CartConvertedSubscriber implements EventSubscriberInterface { public static function getSubscribedEvents(): array { return [ CartConvertedEvent::class => 'onCartConverted', ]; } public function onCartConverted(CartConvertedEvent $event): void { $order = $event->getConvertedCart(); $customFields = [ 'your_custom_field_key' => 'your_custom_field_value' ]; $order->setCustomFields($customFields); } } |
2. Register Your Subscriber: Ensure your subscriber is registered in your service configuration.
yaml
| 1 2 3 4 5 6 7 8 9 | # config/services.yaml services: YourNamespace\EventSubscriber\CartConvertedSubscriber: tags: - { name: 'kernel.event_subscriber' } |
3. Verify Custom Fields in Order Confirmation Email: After implementing the subscriber, the custom fields should now be available in the order confirmation email template.
In your email template, you can access the custom fields like so:
twig
| 1 2 3 | {# Assuming your custom field key is 'your_custom_field_key' #} {{ order.customFields.your_custom_field_key }} |
Conclusion
By saving custom fields during the CartConvertedEvent in Shopware 6, you ensure they are included in the order before the order confirmation email is triggered. This approach resolves the issue where custom fields saved during CheckoutOrderPlacedEvent are not available in the email. This eliminates the problem that arises when custom fields created at the time of CheckoutOrderPlacedEvent are not available in the email. Applying this solution contributes to the process becoming less chaotic and makes the customization of the Shopware 6 platform’s email functions more versatile. For more assistance and expert solutions, consider consulting with a Shopware agency to optimize your e-commerce platform effectively.
Recent help desk articles
Greetings! I'm Aneesh Sreedharan, CEO of 2Hats Logic Solutions. At 2Hats Logic Solutions, we are dedicated to providing technical expertise and resolving your concerns in the world of technology. Our blog page serves as a resource where we share insights and experiences, offering valuable perspectives on your queries.
