Skip to content

[MERC-1039] Remove Shopify public apps from the docs #1860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
codatchris wants to merge 7 commits into
base: main
Choose a base branch
from
Open

[MERC-1039] Remove Shopify public apps from the docs #1860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
270049a
[MERC-1039] Remove Shopify public apps from the docs
codatchris Jun 1, 2026
9f54f2a
Merge branch 'main' into shopify-public-apps-deprecation-notice
codatchris Jun 4, 2026
36c1207
[MERC-1039] Soften Shopify deprecation notice wording
codatchris Jun 8, 2026
86cd914
[MERC-1039] Update Shopify deprecation notice date to 2026-07-02
codatchris Jul 1, 2026
7099ead
[MERC-1039] Set Shopify deprecation notice title/date to 2026-07-02
codatchris Jul 1, 2026
d64c123
Merge remote-tracking branch 'origin/main' into shopify-public-apps-d…
codatchris Jul 1, 2026
5b2d06b
[MERC-1039] Fix commerce overview table: remove phantom 7th column
codatchris Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions blog/260702-shopify-public-apps-deprecation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "2026-07-02: Deprecation of the Shopify public apps connection method"
date: "2026-07-02"
tags: ["Deprecation", "Shopify"]
authors: codatchris
---

Codat is deprecating the **public apps** connection method for the Shopify integration in favour of the simpler [custom apps](/integrations/commerce/shopify/commerce-shopify-custom-apps) approach.

<!--truncate-->

## What's changing

The Shopify integration historically supported two ways for a merchant to connect their store:

- **Custom apps** — the merchant creates a custom app in their Shopify admin and provides the store name, client ID, and client secret during the Codat Link flow. This is the standard method.
- **Public apps** — the client builds a public Shopify app, submits it to Shopify for approval, hosts an authorization endpoint, and configures the app's credentials in Codat.

The **public apps** method is being deprecated and removed. It places a significant setup burden on clients, who must create and submit a public Shopify app for Shopify's review and approval, and develop and host an endpoint to authorize each merchant. Custom apps remove these requirements, so we are standardizing on the simpler custom apps approach for all Shopify connections.

## Alternatives

Use the [custom apps connection method](/integrations/commerce/shopify/commerce-shopify-custom-apps) for all Shopify connections. Compared with public apps, custom apps:

- Don't require you to build and submit your own public Shopify app.
- Don't require you to build and host a merchant authorization endpoint.
- Guide the merchant through creating the app and entering their credentials with an in-flow, step-by-step **Find your Shopify credentials** section.

## Action required

For the vast majority of clients, **no action is required** — Shopify connections already use custom apps.

If you currently rely on the public apps connection method, switch to [custom apps](/integrations/commerce/shopify/commerce-shopify-custom-apps) before connecting any new merchants.

If you have questions or need assistance, reach out to your dedicated Codat representative or contact our [support team](mailto:support@codat.io).

## Expected impact if no action is taken

The public apps connection method will stop working, and merchants will no longer be able to start new connections through it. Existing, already-linked Shopify connections are unaffected and continue to sync. Any client still onboarding merchants through public apps must move to custom apps to continue connecting new stores.
6 changes: 6 additions & 0 deletions blog/authors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ codat-bot:
url: https://github.com/codat-engineering
image_url: https://github.com/codat-engineering.png

codatchris:
name: Chris Farrar
title: Senior Software Engineer
url: https://github.com/codatchris
image_url: https://github.com/codatchris.png

Huweey:
name: Huw Thomas
title: Software Engineer
Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/commerce/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@
Our documentation details the specific setup steps and requirements for each supported commerce software.

| Platform | Registration required | Registration complexity | Marketplace partner program | Connection restrictions | Additional information |
| ---------------------------------------------------------------------------------------------------- | --------------------- | ----------------------- | --------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| ---------------------------------------------------------------------------------------------------- | --------------------- | ----------------------- | --------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Amazon seller central](/integrations/commerce/amazon-seller-central/commerce-amazon-seller-central) | Yes\* | Hard | Yes | No | \* You can request Codat's marketplace credentials to avoid registration by emailing solutions@codat.io. |
| [BigCommerce](/integrations/commerce/bigcommerce/commerce-bigcommerce) | No | Not required | No | No | To use this integration, a merchant must have the correct scopes set. If they don't have these scopes set, they need to create a new store API account and enter their new store credentials in Link (see [SMB customer: Authenticate and connect your commerce data](/integrations/commerce/bigcommerce/commerce-bigcommerce-setup#smb-customer-authenticate-and-connect-your-commerce-data)). |
| [Clover](/integrations/commerce/clover/commerce-clover) | Yes | Easy | Yes | Yes | Companies that offer lending services are not able to use the Clover API. <br/>There are Sandbox and Production developer portals available. The Production portal differs for the US & Canada and UK & Europe. |
| [Lightspeed Restaurant (K Series)](/integrations/commerce/lightspeed-k/commerce-lightspeed-k) | Yes | Easy | Yes | No | Partner application review typically takes up to 7 working days. | |
| [Shopify](/integrations/commerce/shopify/commerce-shopify) | Yes\* | Hard | Yes | Yes | \* Companies that provide capital loans are not able to register a public app with Shopify. <br/> Public app approval may take up to 2 weeks. Codat offers [connections via custom apps](/integrations/commerce/shopify/commerce-shopify-custom-apps) as an alternative. |
| [Lightspeed Restaurant (K Series)](/integrations/commerce/lightspeed-k/commerce-lightspeed-k) | Yes | Easy | Yes | No | Partner application review typically takes up to 7 working days. |

Check warning on line 33 in docs/integrations/commerce/overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'app' instead of 'application'.

Raw Output:
{"message": "[Google.WordList] Use 'app' instead of 'application'.", "location": {"path": "docs/integrations/commerce/overview.md", "range": {"start": {"line": 33, "column": 220}}}, "severity": "WARNING"}

Check warning on line 33 in docs/integrations/commerce/overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/integrations/commerce/overview.md", "range": {"start": {"line": 33, "column": 26}}}, "severity": "INFO"}
Comment thread
codatchris marked this conversation as resolved.
Comment thread
codatchris marked this conversation as resolved.
| [Shopify](/integrations/commerce/shopify/commerce-shopify) | No | Not required | No | No | Merchants connect using a [custom app](/integrations/commerce/shopify/commerce-shopify-custom-apps) created in their own Shopify store. |
| [Square](/integrations/commerce/square/commerce-square) | Yes | Easy | Yes | No | |
| [Stripe](/integrations/commerce/stripe/commerce-stripe) | Yes | Easy | Yes | No | Production accounts must be verified by Stripe. |
| [WooCommerce](/integrations/commerce/woocommerce/commerce-woocommerce) | No | Not required | No | No | |
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/commerce/shopify/commerce-shopify-custom-apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Set up Shopify using custom apps"
description: "Learn how to set up the Shopify integration using the custom apps approach to merchant data connection"
sidebar_label: Custom apps
sidebar_label: Setup
---

This article explains how to set up the Shopify integration using the _custom apps_ approach for enabling your merchants to connect and share their commerce data.
Expand Down
Loading
Loading