Shopify (Public App) – Configuration Guide

Service ID: shopify-public-app

Sell anywhere, to anyone, with Shopify’s ecommerce platform and point of sale features. Public App OAuth for multi-tenant merchant connections.

How to register an OAuth app for Shopify (Public App)

Shopify's Public App connector uses the OAuth 2.0 authorization code grant, allowing your merchants to connect their Shopify stores without creating their own app credentials. You register one Shopify Partners app, and all merchants connect via a standard OAuth installation flow.

1. Create a Shopify Partners App

  1. Log in to the Shopify Partners dashboard.
  2. Navigate to Apps and click Create app.
  3. Choose Create app manually and enter your app name.
  4. Note the Client ID (API key) and Client secret — you'll need these later.

2. Configure the Redirect URL

In your Shopify Partners app settings, add the Apideck callback URL as an allowed redirect URL:

https://unify.apideck.com/vault/callback

3. Configure API Scopes

In the app configuration, request the following Admin API access scopes:

ScopeDescription
read_ordersRead orders
read_productsRead products
read_customersRead customers
read_inventoryRead inventory
read_locationsRead locations
read_fulfillmentsRead fulfillments
read_assigned_fulfillment_ordersRead assigned fulfillment orders
read_draft_ordersRead draft orders
read_discountsRead discounts
read_gift_cardsRead gift cards
read_returnsRead returns
read_shippingRead shipping
read_product_listingsRead product listings
read_localesRead locales
read_metaobjectsRead metaobjects
write_webhooksManage webhooks

4. Configure Shopify in Apideck

  1. Go to the Apideck Dashboard
  2. Enter your Shopify Partners app Client ID and Client secret
  3. Review the scopes to ensure they match your Shopify Partners app configuration
  4. Click Save settings

Test your integration

After a merchant connects their Shopify store through Vault, you can test the integration using the Apideck Unified APIs.

To retrieve orders from a connected Shopify store:

curl --location --request GET 'https://unify.apideck.com/ecommerce/orders' \
--header 'x-apideck-consumer-id: test-consumer' \
--header 'x-apideck-app-id: {APIDECK_APP_ID}' \
--header 'x-apideck-service-id: shopify-public-app' \
--header 'Authorization: Bearer {APIDECK_API_KEY}'

Start building with the Shopify API

Learn what else you can build with the Shopify API or explore the Apideck Ecommerce API documentation.

Troubleshooting

Error: Invalid redirect_uri

Ensure that the redirect URI https://unify.apideck.com/vault/callback is added to your Shopify Partners app's allowed redirect URLs.

Error: OAuth credentials not found

This means the Client ID and Client secret have not been configured at the Integration level in the Apideck Dashboard. Follow step 4 above.

Error: Insufficient scopes

If merchants receive permission errors, verify that the scopes configured in your Shopify Partners app match the scopes listed in step 3.