For the complete documentation index, see llms.txt. This page is also available as Markdown.

Shoplazza

This guide is intended for Shoplazza merchants who are connecting their store to Violet. During this process, the merchant will create a Private App in their Shoplazza admin dashboard to generate an Access Token, and then provide it to Violet through the Violet Connect onboarding tool. The merchant will retain full control of the created Private App and can modify or delete it at any time from within their Shoplazza admin dashboard. Total time for completion is around 5 minutes.

Step 1: Creating a Private App

The Access Token is required to connect your Shoplazza store to Violet. It is generated by creating a Private App in your Shoplazza admin.

  1. Log in to your Shoplazza admin dashboard as the store owner.

  2. Navigate to Apps > Manage Private Apps.

  3. Click "Create App".

  4. Enter an app name (e.g., "Violet Integration").

  5. Enter an emergency developer email address.

  6. Select the Webhook API version (use the default/latest).

  7. Grant the following permissions:

Permission
Purpose

read_product

Sync your product catalog to Violet

read_order

Import order data

write_order

Enable Direct Order Submission

read_customer

Access customer data on orders

read_collection

Sync product collections

read_shop

Access store profile information

  1. Click Create to generate the Private App.

  2. Copy the Access Token that is displayed.

The Access Token is a long-lived, static credential. It does not expire and does not need to be refreshed.

Step 2: Provide Credentials to Violet

Once you have your Access Token, return to the Violet Connect onboarding tool and enter the following:

  1. When prompted for your store URL, enter the full URL of your Shoplazza store including the protocol. Example: https://mystore.myshoplazza.com.

  2. Enter your Access Token obtained in Step 1 in the "Access Token" field.

Once entered, click the Connect button to validate the credentials and complete the connection between your store and Violet. Violet will verify your Access Token by connecting to your Shoplazza store — if the token is invalid, you will receive an error message.

If the credentials are invalid, check for:

  • Spaces or other copy/paste errors in the Access Token

  • The store URL is correct (e.g., https://mystore.myshoplazza.com)

  • The Private App has not been deleted

  • The required permissions were granted when creating the Private App

Upon success you will be redirected back to the channel who first sent you to Violet.


Credential Summary

Credential
Required
Where to Find

Store URL

Yes

Your Shoplazza store URL (e.g., https://mystore.myshoplazza.com)

Access Token

Yes

Shoplazza admin > Apps > Manage Private Apps > Create App


Special Considerations

Required Permissions

When creating the Private App, you must grant all six permissions listed in Step 1. If any required permission is missing, some Violet features may not work correctly. You can update permissions by editing the Private App in Apps > Manage Private Apps.

Revoking Access

You can revoke Violet's access at any time by deleting the Private App in Apps > Manage Private Apps. This will immediately disconnect your store from Violet until a new Private App is created and its Access Token is provided.

Webhooks

Violet automatically registers webhooks on your Shoplazza store during the connection process. These webhooks notify Violet of product and order changes in real time. You do not need to configure webhooks manually.

Last updated

Was this helpful?