Skip to main content

Create an app

To use the Shop APIs and SDKs, you need an app in the Dev Dashboard. This guide covers creating an app, configuring scopes, and retrieving your credentials.

Developer preview

The Shop platform is in early access. Features and APIs may change before general availability.

Anchor to What you'll learnWhat you'll learn

  • Create an app in the Dev Dashboard.
  • Release a version with the appropriate scopes.
  • Retrieve your client ID and client secret.

Anchor to RequirementsRequirements

Anchor to Step 1: Log in to the Dev DashboardStep 1: Log in to the Dev Dashboard

Go to the Dev Dashboard and log in with your partner account.

Anchor to Step 2: Create an appStep 2: Create an app

  1. From the Dev Dashboard, create a new app.
  2. Enter a name and description for your app.

Anchor to Step 3: Release a versionStep 3: Release a version

After you've created your app, you need to release a version. Versions let you configure the scopes and redirect URLs for your app.

  1. In the sidebar on the left, click Versions.
  2. Click Release in the top right.
  3. Under the Access section, click the first Select scopes, then use the dropdown menu to choose Shop App.
  4. Select the scopes you need from the list.
  5. In the Redirect URLs section, add the URLs that you want to redirect back to after authentication. Only fully-qualified https URLs are supported.
  6. Click Release.

Anchor to Step 4: Retrieve your credentialsStep 4: Retrieve your credentials

After you've released a version, you can find your credentials on the app's Settings page. You'll need the following values to authenticate with Shop APIs:

  • Client ID: Used as the username for Shop Partners API Basic authentication, and as the apiKey attribute on Shop SDK components.
  • Client secret: Used as the password for Shop Partners API Basic authentication.
Keep your secret safe

Store your client secret securely. You'll need it to authenticate with the Shop Partners API.

Anchor to Next stepsNext steps

Was this page helpful?