checkout object webUrl changed from 'checkouts' to 'cart' after upgrading from v2 to v3 breaking our attribution tracking

[arenoir]

Bug details

Describe the bug
After upgrading from v2 to v3 of this package the checkout object webUrl property changed from.

https://my-store.myshopify.com/\d+/checkouts/

TO

https://my-store.myshopify.com/cart/

The new "/cart" url then redirects to the original checkouts url however all query params that we have append to the webURL property are lost on redirect.

Why does the webURL property return a "cart" redirect url and how can we fix this?

Thank you.

To Reproduce
upgrade from v2 to v3

Expected behavior
Expect the webUrl to stay the same between upgrades or at least the query params to be passed through to the checkouts url on redirect.

Environment (please complete the following information):

• OS: all
• Browser all
• Shopify API version: '2025-01';

Bug Report Checklist

• I have read and agree to the CODE_OF_CONDUCT.md
• I have read the CONTRIBUTING.md guidelines.
• I have provided a detailed description of the bug, including code samples, and/or network data.
• I have provided information about my development environment, including SDK version.

[kdaviduik]

Hey @arenoir, thanks for reporting this! We are investigating

[juanpprieto]

I could not replicate this issue.

Can you please let us know what params are you not able to forward? Better yet, could you share a gist of the relevant code snippet that appends the params to the webUrl?

[arenoir]

Here is the relevant code that adds the _ga linker param to the webUrl. This works it is just not being passed through to the checkout page. The _ga linker param is present on the new "cart" page that immediately redirects to the old "checkouts" page.

  // this.#checkout a instance of checkout object.
  // https://shopify.dev/docs/api/storefront/2024-04/objects/checkout#field-weburl
  get checkoutUrl() {
    return this.#checkout?.webUrl;
  }

  // Add google analytics linkerParam if loaded and linker is enabled for the current domain.
  // https://developers.google.com/analytics/devguides/collection/analyticsjs/linker
  //
  // Note: linker params expire after 2 minutes so it is best to call this function right before checkout.
  //
  buildCheckoutUrlWithLinkerParam() {
    const linkerParam = this._buildGaLinkerParam();

    if (!linkerParam) return this.checkoutUrl;

    const url = new URL(this.checkoutUrl);

    url.searchParams.append(linkerParam[0], linkerParam[1]);

    return url.toString();
  }

  _buildGaLinkerParam() {
    const linkerParam = window.ga?.getAll?.()?.[0]?.get('linkerParam');

    if (!linkerParam) return;

    return linkerParam.split('=');
  }

Here are our tests, you can see the before v3 and after v3 urls. Is the "cart" the correct url for checkouts now?

[juanpprieto]

Thanks!

Here are our tests, you can see the before v3 and after v3 urls. Is the "cart" the correct url for checkouts now?

Yes, this is expected as v3 now uses the Cart API to emulate the deprecated Checkout API functionality as described on the FAQ.

I'm investigating the URL params forwarding issue, I'll get back to you when I have some updates

[juanpprieto]

Hey @arenoir

I can't replicate the issue where linker params are stripped during the checkout redirect.

Here's an example of some fictional linker params making it all the through to checkout in my small test

If you are concerned just based on your failing test, I would proceed to update it to match the new webUrl including /cart

Let me know if you still have issues with the linker params. I might need a simple reproduction repo if this is still the case.

[arenoir]

Thanks @juanpprieto for taking the time to investigate.

Thanks for confirming that the cart path is correct.

Our attribution issue is a direct result of the path change as the checkout url used to go directly to the checkouts page without being redirected.

Using the chrome redirect addon you can see that the query params are dropped on the fourth redirect.

302	https://us-wp.myshopify.com/cart/c/Z2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy?key=a8efb34dcfe85ff9294d5c983cf61f0e&_ga=2.101950724.44294659.1742840001-1277802314.1726503015	23.227.38.74	server_redirect	temporary	https://shop.app/checkout/34379038858/cn/Z2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy/shop_pay_callback?_ga=2.101950724.44294659.1742840001-1277802314.1726503015&locale=en-US&redirect_source=checkout_universal_redirect&token=\&tracking_unique=7D852160-5684-4FD3-9986-1cba39240ebf&tracking_visit=D2CA2465-cb08-4566-a11c-7cfdf985fbd5&ur_back_url=https%3A%2F%2Fus-wp.myshopify.com%2Fcheckouts%2Fcn%2FZ2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy%3F_ga%3D2.101950724.44294659.1742840001-1277802314.1726503015%26auto_redirect%3Dfalse%26edge_redirect%3Dtrue%26locale%3Den-US%26skip_shop_pay%3Dtrue&ur_verify=8q3Mh64Vl_X9GDioxEoKOeYKnc0%3D
302	https://shop.app/checkout/34379038858/cn/Z2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy/shop_pay_callback?_ga=2.101950724.44294659.1742840001-1277802314.1726503015&locale=en-US&redirect_source=checkout_universal_redirect&token=jFZqi4WnE3wiiu0IlADO8ecjg361GMj2OKVfWpoJPYY&tracking_unique=7D852160-5684-4FD3-9986-1cba39240ebf&tracking_visit=D2CA2465-cb08-4566-a11c-7cfdf985fbd5&ur_back_url=https%3A%2F%2Fus-wp.myshopify.com%2Fcheckouts%2Fcn%2FZ2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy%3F_ga%3D2.101950724.44294659.1742840001-1277802314.1726503015%26auto_redirect%3Dfalse%26edge_redirect%3Dtrue%26locale%3Den-US%26skip_shop_pay%3Dtrue&ur_verify=8q3Mh64Vl_X9GDioxEoKOeYKnc0%3D	185.146.173.20	server_redirect	temporary	https://shop.app/checkout/34379038858/cn/Z2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy/shoppay?_ga=2.101950724.44294659.1742840001-1277802314.1726503015&redirect_source=checkout_universal_redirect&tracking_unique=7D852160-5684-4FD3-9986-1cba39240ebf&tracking_visit=D2CA2465-cb08-4566-a11c-7cfdf985fbd5
200	https://shop.app/checkout/34379038858/cn/Z2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy/shoppay?_ga=2.101950724.44294659.1742840001-1277802314.1726503015&redirect_source=checkout_universal_redirect&tracking_unique=7D852160-5684-4FD3-9986-1cba39240ebf&tracking_visit=D2CA2465-cb08-4566-a11c-7cfdf985fbd5	185.146.173.20	client_redirect	javascript	https://us-wp.myshopify.com/checkouts/cn/Z2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy?locale=en-US&skip_shop_pay=true
200	https://us-wp.myshopify.com/checkouts/cn/Z2NwLXVzLXdlc3QxOjAxSlE0TlFXOVBXODM1WFYxUEUyTldSRjMy?locale=en-US&skip_shop_pay=true	23.227.38.74	normal	none	none

This is looking like an greater issue with shopify and not with this package.

[juanpprieto]

Hi @arenoir thanks for the detailed trace. I will forward this to the team, but yeah this seems to be a wider use case not fully related to this particular upgrade.

I would try to investigate alternatives in the mean time.