Skip to main content

Get OAuth Config

GET 
/api/shopify/config

Returns the Shopify OAuth configuration that tells the frontend which connection mode to render.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Response fields:

  • custom_app_mode (bool): when true, per-instance Client ID/Secret are used (custom app). When false, SKU.io's central public app credentials are used.
  • legacy_custom_app_mode (bool): when true, the merchant pastes an Admin API access token directly (no OAuth).
  • scopes (string): comma-separated OAuth scopes requested.
  • redirect_url (string): the OAuth callback URL ({app_url}/shopify/callback).

Mode matrix:

  • Public OAuth: custom_app_mode=false, legacy_custom_app_mode=false (no credentials entered; merchant just authorizes).
  • Custom-app OAuth: custom_app_mode=true, legacy_custom_app_mode=false.
  • Legacy custom app: legacy_custom_app_mode=true.

Note: custom_app_mode and legacy_custom_app_mode are resolved per-tenant. A tenant may override either flag (operators set this via the shopify:set-app-mode artisan command); when no override is present the global config default applies. The response shape is identical regardless of how the values resolve, so different tenants may legitimately return different mode values.

Request​

Responses​

OK

Response Headers
    Content-Type