Prerequisites

Before you can pre-register merchants, you need credentials from the Shopify Partner Dashboard. This is a one-time setup per merchant.

Required Access

  • Shopify Partner Dashboard account with permission to create custom apps

  • Access to your channel's Violet account (Channel Dashboard)

Don't have a Shopify Partner account? Visit partners.shopify.com/signup to create one. Complete the registration, verify your email, and complete your partner profile.


Getting Your Credentials

For each merchant you want to onboard, you'll need two pieces of information from Shopify:

  1. Client ID: OAuth client identifier (identifies your app)

  2. Client Secret: OAuth secret key (authenticates your app)

  3. Install Link: Merchant-specific Shopify authorization URL

How to get these credentials:

  1. Navigate to App DistributionCreate an app

    1. Note: you may need to navigate to Visit Dev Dashboard, if prompted.

  2. Choose Create an app and select Custom app

  3. Configure the app:

    • App name: Use a descriptive name (e.g., "Your Channel Name - Merchant Name")

    • Admin API access scopes: Select required permissions (see list below)

    • Save: Click to generate credentials

  4. Copy credentials immediately (before navigating away):

    • Copy the Client ID

    • Copy the Client SecretThis appears only once. If you lose it, you must regenerate it.

    • Copy the Install link

  5. Immediately go to Violet Channel Dashboard and paste all three credentials into the pre-registration form while they're fresh

    • Do not wait or close Shopify without saving these values

Step-by-Step Instructions

1. Log in to Shopify Partner Dashboard

Shopify Partners Dashboard

2. Navigate to Apps → Create an app

Shopify Dev Dashboard

3. Choose "Create an app" and select "Custom app"

4. Configure the app:

Shopify App Creation
Setting
Value

App name

Use a descriptive name (e.g., "Your Channel - Merchant Name")

Admin API access scopes

Select all required permissions from the API Scopes section below

Redirect URI

See redirect URI format below

Redirect URI Format: Use your channel's app alias in the redirect URI:

  • Production: https://connect.violet.io/{APP_ALIAS}/platforms/shopify/connect

  • Sandbox: https://connect.violet.dev/{APP_ALIAS}/platforms/shopify/connect

Find your app alias in Channel Dashboard > App Settings > Violet Connect.

5. Copy credentials immediately (before navigating away)

Shopify App Credentials
  • Copy the Client ID

  • Copy the Client SecretThis appears only once. If you lose it, you must regenerate it.

6. Go to Violet Channel Dashboard and paste both credentials into the pre-registration form while they're fresh


Required API Scopes

Your custom app must have the following Shopify Admin API scopes. These permissions allow Violet to perform checkout and catalog operations on behalf of your channel.

Core Product & Inventory Scopes

Scope
Purpose

read_products

Used to read your product catalog

read_inventory

Used to read inventory data related to your products

read_locations

Used to read inventory location data related to your products

Customer Scopes

Scope
Purpose

write_customers

Used to add new customers when performing non-guest checkouts

read_customers

Used to read customer information for order processing

Order & Checkout Scopes

Scope
Purpose

write_orders

Used to create and update orders during checkout

read_orders

Used to read orders previously submitted by Violet into your system

write_draft_orders

Used to populate and submit orders into your system

read_draft_orders

Used to read draft order data

write_merchant_managed_fulfillment_orders

Used to alert you when an order placed through Violet requires additional review before being fulfilled. This can be useful in mitigating fraud.

Fulfillment & Shipping Scopes

Scope
Purpose

read_fulfillments

Used to read and communicate order fulfillment statuses to the channel

read_shipping

Used to understand your shipping policies

read_markets

Used to understand the regions you ship to

Pricing & Discount Scopes

Scope
Purpose

read_price_rules

Used to understand the pricing rules related to your discounts

read_discounts

Used to understand the combination policies of your discounts

Policy & Returns Scopes

Scope
Purpose

read_legal_policies

Used to understand your refund and return policies

read_returns

Used to discover when a Violet-sourced order has been returned

Unauthenticated Scopes (for Cart Operations)

Scope
Purpose

unauthenticated_write_checkouts

Used to create carts without being subjected to Shopify's rate limits

unauthenticated_read_product_listings

Used to read basic product data when creating carts without being subjected to Shopify's rate limits

unauthenticated_read_product_inventory

Used to read product inventory data when creating carts without being subjected to Shopify's rate limits

Why so many scopes? Violet provides a complete checkout experience including product display, inventory checking, cart creation, order submission, fulfillment tracking, and returns handling. Each scope enables a specific capability that merchants and channels rely on.


Summary Checklist

Before proceeding to pre-registration, confirm you have:


Next step: Go to Pre-Registration Process to register merchants in Channel Dashboard.

Last updated

Was this helpful?