Meta Checkout URL Implementation #39667

sol-loup · 2025-02-27T22:41:02Z

Meta Checkout URL Implementation

This PR adds support for Meta's checkout URL specification, allowing direct linking to the checkout page with pre-populated cart items and coupon codes.

What's Changed

Added AddToCartLinkV1 controller that processes URL parameters to populate the cart
Added layout XML file to render the checkout page with consistent user experience
Implemented support for multiple products and coupon codes via URL parameters

How It Works

The controller accepts URL parameters in this format:
/checkout/cart/addtocartlinkv1?products=123:2,456:1&coupon=SAVE10

This will:

Clear the existing cart (per Meta requirements)
Add 2 units of product Performance problem & memory leak in Mage_Index_Model_Process #123 and 1 unit of product Bogus error message if mcrypt extension is not installed. #456
Apply the "SAVE10" coupon code
Display the checkout page

The implementation handles error cases gracefully, showing appropriate messages for invalid products or coupons.

Resolved issues:

resolves [Issue] Meta Checkout URL Implementation #39700: Meta Checkout URL Implementation

…ta Checkout URL implementation

m2-assistant · 2025-02-27T22:41:06Z

Hi @sol-loup. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

engcom-Hotel · 2025-03-03T16:38:19Z

@magento run all tests

engcom-Hotel · 2025-03-04T11:20:53Z

@magento create issue

engcom-Hotel · 2025-03-06T06:53:17Z

@magento run all tests

engcom-Hotel

Hello @sol-loup,

Thanks for the contribution.

I can see we can handle Simple product scenarios with this, but how can we handle the configurable products.

Also, I guess we can add an automated test for this newly added functionality.

engcom-Hotel · 2025-03-06T10:58:23Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+/**
+ * Controller for Meta Checkout URL implementation
+ */
+class AddToCartLinkV1 implements HttpGetActionInterface, ActionInterface


Remove the redundant implementation of ActionInterface. It is already implemented by HttpGetActionInterface.

engcom-Hotel · 2025-03-06T10:59:45Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+    public function __construct(
+        Context $context,
+        CheckoutSession $checkoutSession,
+        ProductRepositoryInterface $productRepository,
+        Cart $cart,
+        PageFactory $resultPageFactory,
+        RedirectFactory $resultRedirectFactory,
+        CouponFactory $couponFactory,
+        Usage $couponUsage,
+        ManagerInterface $messageManager
+    ) {


Use Constructor readonly properties

engcom-Hotel · 2025-03-06T11:25:45Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+                    $qty = $item['qty'];
+
+                    $product = $this->productRepository->getById($productId);
+                    $this->cart->addProduct($product, ['qty' => $qty]);


I guess we can pass $product->getId(), instead of passing $product as addProduct method requires either int or \Magento\Catalog\Model\Product parameter

engcom-Hotel · 2025-03-06T11:26:47Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+     *
+     * @return \Magento\Framework\Controller\ResultInterface
+     */
+    public function execute()


Add a return type declaration.

engcom-Hotel · 2025-03-06T11:27:29Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+     * @param string $productsParam
+     * @return array
+     */
+    private function parseProductsParam($productsParam)


Add a return type declaration and also add a parameter type declaration.

engcom-Hotel · 2025-03-06T11:30:52Z

app/code/Magento/Checkout/view/frontend/layout/checkout_cart_addtocartlinkv1.xml

+ * See COPYING.txt for license details.
+ */
+-->
+<?xml version="1.0"?>


I think we can remove this redundant statement

engcom-Charlie · 2025-03-11T06:25:33Z

Hi @sol-loup,

Thank you for your contribution!

Can you please look into the review comments and do the needful.

…to 2.4-develop

sol-loup · 2025-03-15T00:19:48Z

@engcom-Hotel @engcom-Charlie , I've made the requested updates.

I've also added a unit test as requested; test output:

vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist vendor/magento/module-checkout/Test/Unit/Controller/Cart/.
PHPUnit 9.6.20 by Sebastian Bergmann and contributors.

....... 7 / 7 (100%)

Time: 00:00.563, Memory: 10.00 MB

OK (7 tests, 47 assertions)

sol-loup · 2025-03-15T00:49:09Z

Hello @sol-loup,

Thanks for the contribution.

I can see we can handle Simple product scenarios with this, but how can we handle the configurable products.

Also, I guess we can add an automated test for this newly added functionality.

This is a good callout; I've adjusted the logic to prioritize sku instead.

This will allow specific configurations to be purchased via SKU -- this will allow most standard configurable variable items to flow through this feature. Customizable products are a special case, and IMO, not well handled even by other e-commerce platforms.

Example here:
https://one.staging.magento-commerce-extension-testing.com/checkout/cart/addtocartlinkv1?products=12345:2

sol-loup · 2025-04-07T21:59:12Z

Hi @sol-loup and @engcom-Bravo,

I have tried to check different scenarios on my local environment on PR branch When I have tried to browse http://39667.local/checkout/cart/addtocartlinkv1?products=abc:5, it gave me correct page.
But when I have tweaked the URL by adding extra letter before product, like http://39667.local/checkout/cart/addtocartlinkv1?aproducts=abc:5&b=23 then its giving me checkout page but without the item details. I think, we should handle all such scenarios here.
@sol-loup let me know if I am missing anything. @engcom-Bravo please check it with all the possible scenarios. Till then moving it to Ready for Testing again.

Hey @engcom-Charlie. In this case, you are passing an invalid parameter, and you are just landing on your previous valid cart, whatever that cart may have been. If you feel an explicit error message is more appropriate here, happy to add that.

engcom-Charlie · 2025-04-08T05:29:36Z

Hi @sol-loup and @engcom-Bravo,
I have tried to check different scenarios on my local environment on PR branch When I have tried to browse http://39667.local/checkout/cart/addtocartlinkv1?products=abc:5, it gave me correct page.

But when I have tweaked the URL by adding extra letter before product, like http://39667.local/checkout/cart/addtocartlinkv1?aproducts=abc:5&b=23 then its giving me checkout page but without the item details. I think, we should handle all such scenarios here.
@sol-loup let me know if I am missing anything. @engcom-Bravo please check it with all the possible scenarios. Till then moving it to Ready for Testing again.

Hey @engcom-Charlie. In this case, you are passing an invalid parameter, and you are just landing on your previous valid cart, whatever that cart may have been. If you feel an explicit error message is more appropriate here, happy to add that.

Hi @sol-loup,

Yes, I have tweaked the URL by passing wrong params. Showing the previous cart on this wrong URL doesn't make any sense. It will be good if we handled it correctly. You can check how such cases are getting handled right now. Eg. either by showing error or most appropriately by showing below page.

…to 2.4-develop

sol-loup · 2025-04-17T21:19:08Z

Hey @engcom-Charlie -- I have applied the change allowing for configuration from the "Checkout" configurations in Magento:

I have also added logic adding a &store param, allowing sellers on multi-site setups to specify which store (if any) they'd like the checkout to occur from.

I have added the noroute behavior in the case where the functionality is disabled. However, I am not comfortable proceeding with the cart deletion logic you have suggested here. This could potentially be a destructive act if the buyer has an active cart session from some other previous shopping session. In the event the Add To Cart Link is invalid, I would prefer not to delete their pre-existing cart.

engcom-Charlie · 2025-04-21T07:37:28Z

Hi @sol-loup,

Thank you for the updating. @engcom-Hotel Since the review comments have been worked on, moving this PR into review.

engcom-Hotel · 2025-04-23T14:12:28Z

@magento run all tests

engcom-Hotel

Hello @sol-loup,

Thanks for making the changes as per the review comment.

Please fix the failed static and unit test failures and some review comments as below.

Functional test failures seems flaky to me and for semantic version checker failure we need to create an internal JIRA for approval.

Thanks

engcom-Hotel · 2025-04-24T07:26:33Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+        $couponCode = $this->_request->getParam('coupon', '');
+
+        // Get quote from checkout session (should now reflect the correct store)
+        $quote = $this->checkoutSession->getQuote();


Calling getQuote method may return exception, surround it with try... catch block.

engcom-Hotel · 2025-04-24T07:32:01Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+                    $this->messageManager->addErrorMessage(
+                        __('The coupon code "%1" is not valid or cannot be applied.', $couponCode)
+                    );
+                } else {


This else statement has empty body, I think we can remove it.

engcom-Hotel · 2025-04-24T07:33:56Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+        $quote = $this->checkoutSession->getQuote();
+
+        // Ensure quote is associated with the correct store ID after potential switch
+        if ($quote->getStoreId() !== $this->storeManager->getStore()->getId()) {


Handle NoSuchEntityException for getStore method

engcom-Hotel · 2025-04-24T07:35:53Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+
+            // Save quote and collect totals
+            $quote->collectTotals();
+            $quote->save();


Handle Exception for save

engcom-Hotel · 2025-04-24T07:40:34Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+        if (!empty($couponCode)) {
+            try {
+                // Ensure coupon is applied in the context of the potentially switched store
+                $quote->setCouponCode($couponCode)->collectTotals()->save();


The AbstractModel save method has been deprecated, hence please use resource model save method.

engcom-Hotel · 2025-04-24T08:01:30Z

app/code/Magento/Checkout/Test/Unit/Controller/Cart/AddToCartLinkV1Test.php

+        // Create Quote mock with all required methods
+        $this->_quoteMock = $this->getMockBuilder(Quote::class)
+            ->onlyMethods(['removeAllItems', 'addProduct', 'collectTotals', 'save'])
+            ->addMethods(['setCouponCode', 'getCouponCode'])


addMethods is deprecated, please see sebastianbergmann/phpunit#5320

engcom-Hotel · 2025-04-24T08:03:05Z

app/code/Magento/Checkout/Test/Unit/Controller/Cart/AddToCartLinkV1Test.php

+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Controller\ResultInterface;
+use Magento\Framework\Message\ManagerInterface;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;


ObjectManager manager is deprecated, class under test should be instantiated with new keyword with explicit dependencies declaration

engcom-Hotel · 2025-04-24T08:07:47Z

app/code/Magento/Checkout/etc/config.xml

@@ -21,6 +21,7 @@
                <number_items_to_display_pager>20</number_items_to_display_pager>
                <crosssell_enabled>1</crosssell_enabled>
                <enable_clear_shopping_cart>0</enable_clear_shopping_cart>
+                <enable_add_to_cart_link_v1>1</enable_add_to_cart_link_v1>


The default value for the configuration is set to 1 (enabled). This might introduce unintended behavior for stores unaware of this new feature. So please disable it by default

engcom-Hotel · 2025-04-24T09:20:14Z

app/code/Magento/Checkout/Controller/Cart/AddToCartLinkV1.php

+            $parts = explode(':', $pair);
+            if (count($parts) === 2) {
+                $identifier = trim($parts[0]);
+                $qty = filter_var($parts[1], FILTER_VALIDATE_INT); // Validate quantity is an integer


To prevent misuse, please add a maximum limit on the number of products that can be processed in one request.

engcom-Charlie · 2025-04-25T13:53:49Z

Hi @sol-loup,

Can you please have a look into the review comments as well as fix the build failures.

Static test failures: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39667/1fdd1741792c608604490da5fac3f74b/Statics/console-error-logs.html

Unit test failures: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39667/a3e18407c90d68f9ce142440a79d4183/Unit/console-error-logs.html

engcom-Charlie · 2025-04-28T13:48:47Z

Hi @sol-loup,

Did you get a chance to look into above points.

sol-loup · 2025-05-02T18:16:35Z

#39667 (comment)

Hey @engcom-Hotel

I'm working through the other suggestions as we speak, but this particular one I'd like to push back on. In order to activate this functionality, the seller / buyer would need to know the exact link path, so there's a low likelihood this would be consumed by accident. Other platforms, such as Shopify, WooCommerce and BigCommerce, already support this behavior fully by default. Is there a problem with turning this on in a similar fashion?

engcom-Hotel · 2025-05-05T05:59:03Z

Hello @sol-loup,

Regarding this #39667 (comment), this is a completely new feature in Magento. Enabling it silently could lead to store owners being unaware of its presence or impact. That’s why I suggested keeping it disabled by default, allowing store owners to enable it explicitly if they choose to use the feature.

Thanks

sol-loup · 2025-05-06T22:28:15Z

Hello @sol-loup,

Regarding this #39667 (comment), this is a completely new feature in Magento. Enabling it silently could lead to store owners being unaware of its presence or impact. That’s why I suggested keeping it disabled by default, allowing store owners to enable it explicitly if they choose to use the feature.

Thanks

@engcom-Hotel

I’d like to keep this flag enabled for a few reasons:

Accidental use is virtually impossible
a. Path & params: /cart/addtocartlinkv1?productId={{id}}:{{qty}}&coupon={{code}} are not guessable. The handler only fires when that exact pattern is present, so routine crawlers, shoppers, or legacy integrations never hit it unintentionally.
Every modern platform already ships it ON
- Shopify – “Cart permalinks” (public docs).
- WooCommerce – “Add‑to‑cart URLs” (public docs).
- Merchants and growth‑teams now expect this behaviour to “just work.” Disabling it by default forces Magento stores to install extensions or patch core, adding friction that our competitors don’t impose.
Business upside > Theoretical downside
- Campaign lift: agencies report higher CVR when ads land on a pre‑filled cart vs. PDP.
- Ad‑platform parity: Meta, Google P‑Max, TikTok, and affiliate feeds all generate these links automatically for E-Comm platforms once the endpoint exists. Having it active out‑of‑the‑box means Magento merchants will benefit from the same link behaviors on these platforms without additional configuration.
Opt‑out remains: If a merchant truly doesn’t want the feature, they can disable it in Stores › Configuration › Sales › Checkout › “Enable Cart‑URL links”.

In my opinion, this change aligns Magento with industry checkout norms, removes needless adoption friction, and lets merchants start capturing higher‑intent traffic the moment they upgrade.

Happy to tweak wording or docs, but I believe default‑ON is the lowest‑friction, highest‑ROI path for the ecosystem.

…to 2.4-develop

engcom-Hotel · 2025-05-07T06:50:29Z

Hello @sol-loup,

Thank you for your detailed explanation and for providing industry comparisons and business rationale. Let us discussing this feature internally, meanwhile moving this PR On Hold.

Thanks

engcom-Hotel · 2025-05-08T07:46:21Z

Hello @sol-loup,

Thank you for your detailed explanation and for providing industry comparisons and business rationale. I appreciate the thoughtfulness behind your reasoning. However, we would like to reiterate some considerations and address your points according to discussion with the internal team:

Accidental Use:

While the URL pattern is specific, we cannot entirely rule out the possibility of unintended activation, especially in edge cases or during system integrations. A disabled-by-default approach ensures that only merchants who fully understand and intend to use the feature will enable it.

Industry Standards:

While Shopify and WooCommerce may have similar features enabled by default, Magento's ecosystem and user base have their own unique expectations and workflows. Silent enablement of new features could lead to confusion, especially for merchants upgrading from an older version who may not be aware of the change.

Business Benefits vs. Merchant Control:

While the business upside is promising, we must prioritize giving merchants control over their stores' functionality. By keeping the feature disabled initially, we empower merchants to make a deliberate decision to enable it, ensuring they fully understand its behavior and implications.

Opt-Out Option:

While it's true that merchants can disable the feature, it's generally better to follow an opt-in model for new functionality, especially when it changes how the platform behaves out of the box. This avoids surprises and ensures a consistent experience for existing users.

Given these considerations, I would still advocate for keeping the feature disabled by default upon release. This approach minimizes potential risks while still allowing merchants to leverage the feature if they see fit. I'd be happy to collaborate further to refine the documentation or messaging around this feature to ensure its value is clearly communicated.

Thanks

Adding AddToCartLinkV1 controller and checkout_cart_link route for Me…

a04c158

…ta Checkout URL implementation

Merge branch '2.4-develop' into 2.4-develop

c345b33

engcom-Hotel self-requested a review March 3, 2025 16:37

engcom-Hotel added this to Pull Request Progress Mar 3, 2025

engcom-Hotel moved this to Ready for Review in Pull Request Progress Mar 3, 2025

engcom-Hotel added the Progress: pending review label Mar 3, 2025

m2-assistant bot mentioned this pull request Mar 4, 2025

[Issue] Meta Checkout URL Implementation #39700

Open

engcom-Hotel added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 4, 2025

Merge branch '2.4-develop' into 2.4-develop

87aa6ac

engcom-Hotel moved this from Ready for Review to Review in Progress in Pull Request Progress Mar 6, 2025

engcom-Hotel added Progress: review and removed Progress: pending review labels Mar 6, 2025

engcom-Hotel requested changes Mar 6, 2025

View reviewed changes

engcom-Hotel added Progress: needs update and removed Progress: review labels Mar 6, 2025

engcom-Hotel moved this from Review in Progress to Changes Requested in Pull Request Progress Mar 6, 2025

engcom-Hotel added this to Pull Requests Dashboard Mar 7, 2025

engcom-Hotel removed this from Pull Request Progress Mar 7, 2025

github-project-automation bot moved this to Pending Review in Pull Requests Dashboard Mar 7, 2025

engcom-Hotel moved this from Pending Review to Changes Requested in Pull Requests Dashboard Mar 7, 2025

engcom-Charlie self-assigned this Mar 11, 2025

sol-loup added 2 commits March 14, 2025 17:08

addressing comments

f26b9c4

Merge branch '2.4-develop' of https://github.com/sol-loup/magento2 in…

4402ca3

…to 2.4-develop

engcom-Hotel moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Apr 7, 2025

sol-loup added 2 commits April 17, 2025 14:15

adding configuration values to enable and disable add to cart linking

a3eec99

Merge branch '2.4-develop' of https://github.com/sol-loup/magento2 in…

b793d68

…to 2.4-develop

engcom-Charlie removed the Progress: needs update label Apr 21, 2025

ct-prd-projects-boards-automation bot added the Progress: review label Apr 21, 2025

ct-prd-projects-boards-automation bot moved this from Changes Requested to Review in Progress in Pull Requests Dashboard Apr 21, 2025

Merge branch '2.4-develop' into 2.4-develop

704908d

engcom-Hotel requested changes Apr 24, 2025

View reviewed changes

engcom-Hotel moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Apr 24, 2025

ct-prd-projects-boards-automation bot added Progress: needs update and removed Progress: review labels Apr 24, 2025

changes to satisfy feedback

cbe8c02

Merge branch '2.4-develop' of https://github.com/sol-loup/magento2 in…

38c6902

…to 2.4-develop

engcom-Hotel moved this from Changes Requested to On Hold in Pull Requests Dashboard May 7, 2025

ct-prd-projects-boards-automation bot added Progress: on hold Progress: review and removed Progress: needs update labels May 7, 2025

ct-prd-projects-boards-automation bot moved this from On Hold to Review in Progress in Pull Requests Dashboard May 7, 2025

Meta Checkout URL Implementation #39667

Are you sure you want to change the base?

Meta Checkout URL Implementation #39667

Conversation

sol-loup commented Feb 27, 2025 • edited by m2-assistant bot Loading

Meta Checkout URL Implementation

What's Changed

How It Works

Resolved issues:

m2-assistant bot commented Feb 27, 2025

engcom-Hotel commented Mar 3, 2025

engcom-Hotel commented Mar 4, 2025

engcom-Hotel commented Mar 6, 2025

engcom-Hotel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

engcom-Charlie commented Mar 11, 2025

sol-loup commented Mar 15, 2025

sol-loup commented Mar 15, 2025

sol-loup commented Apr 7, 2025

engcom-Charlie commented Apr 8, 2025

sol-loup commented Apr 17, 2025

engcom-Charlie commented Apr 21, 2025

engcom-Hotel commented Apr 23, 2025

engcom-Hotel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

engcom-Charlie commented Apr 25, 2025

engcom-Charlie commented Apr 28, 2025

sol-loup commented May 2, 2025

engcom-Hotel commented May 5, 2025

sol-loup commented May 6, 2025

engcom-Hotel commented May 7, 2025

engcom-Hotel commented May 8, 2025

sol-loup commented Feb 27, 2025 •

edited by m2-assistant bot

Loading