> For the complete documentation index, see [llms.txt](https://merchant-help.violet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://merchant-help.violet.io/platform-guides/shoplazza.md).

# 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    |

8. Click **Create** to generate the Private App.
9. Copy the **Access Token** that is displayed.

{% hint style="warning" %}
**Important:** The Access Token may only be fully visible once at creation time. Copy and save it securely before navigating away. If you lose the token, you may need to delete the Private App and create a new one.
{% endhint %}

{% hint style="info" %}
The Access Token is a long-lived, static credential. It does not expire and does not need to be refreshed.
{% endhint %}

## 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://merchant-help.violet.io/platform-guides/shoplazza.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.