> 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/spree.md).

# Spree

This guide is intended for SpreeCommerce merchants who are connecting their store to Violet. During this process, the merchant will create a new oAuth application in their Spree dashboard and then provide the generated credentials to Violet through the Violet Connect onboarding tool. The merchant will retain full control of the created oAuth application and can modify or remove it at any time from within their Spree dashboard. *Total time for completion is around 3 minutes.*

## Step 1: Creating App Credentials

1. From the left navigation sidebar of your Spree dashboard navigate to **Apps → oAuth Applications**.
2. In the upper right corner click the `New oAuth application` button.
3. Enter a **Name** for the new application that will remind you of the reason for creating this key. This can be as simple as "Violet" or the name of the channel you are connecting to.
4. In the **Scopes** field enter `admin write`.
5. Click the `Create` button. Your application will now be created.
6. The `Client ID` and `Client Secret` for the newly created application will now be revealed. Copy these values and keep them available for Step 2 of this guide.

## Step 2: Provide App Credentials to Violet

Once you have your **Client ID** and **Client Secret**, it’s time to return to the Violet Connect onboarding tool and enter the follow credentials created in the previous steps:

1. When prompted for your store URL, enter the full URL including the protocol. Example - `https://yourstore.com`.
2. Enter your `Client ID` obtained in the previous steps in the "Client ID" field.
3. Enter your `Client Secret` obtained in the previous steps in the "Client Secret" field.

Once entered, click the **Connect** button to validate the credentials and complete the connection between your store and Violet. If the credentials are invalid you should check for any spaces or other copy/paste errors and try again.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
