# Shoptet

This guide is intended for Shoptet merchants who are connecting their store to Violet. Violet supports two onboarding paths depending on your Shoptet plan:

* **Premium** — you will create a Private API Token in your Shoptet administration and provide it to Violet. This enables full product sync, order submission, and webhook-driven updates.
* **Standard** — you will provide your store URL and a product feed URL. This enables catalog sync via your store's XML feed. No API token is required.

During the Violet Connect onboarding process you will be asked to select which tier you are on, and the form will guide you through the appropriate steps. *Total time for completion is around 5-10 minutes.*

***

## Choosing Your Tier

When you select Shoptet in Violet Connect, you will be prompted to choose your plan:

* Select **Premium** if you have access to the **Connections › Private API** screen in your Shoptet administration. This is available on Shoptet Premium plans and above.
* Select **Standard** if you do not have Private API access. Standard tier uses your store's product feed URL to sync your catalog.

***

## Premium Tier

### Step 1: Creating a Private API Token

1. Sign in to your Shoptet administration and navigate to **Connections › Private API**.
2. Click the **Add** button to create a new token.
3. Enter a **description** for the token (e.g. `Violet integration`) so it is easy to identify later.
4. Submit the form. The new token will appear in the token list, with only the first two and last two characters visible.
5. Click the entry in the list and re-enter your administration password when prompted to reveal the full token.
6. Copy the token value — it will be a 38-60 character alphanumeric string with dashes. You will paste this into Violet in **Step 3**.

{% hint style="info" %}
Each Shoptet eshop allows up to 10 active Private API Tokens. Use a descriptive label so you can rotate or revoke the Violet token without affecting other integrations.
{% endhint %}

### Step 2: Locating Your Eshop URL

1. Your Shoptet eshop URL is the public storefront address that customers use to reach your store (e.g. `https://yourstore.myshoptet.com` or your own custom domain).
2. You can confirm the exact URL in your Shoptet administration under **Settings › Basic settings**, or simply copy it from your browser address bar while viewing the storefront.
3. Have this URL ready — you will paste it into Violet in **Step 3** alongside the token. Violet will normalize the value, so trailing slashes, paths, or mixed casing are fine.

### Step 3: Provide Credentials to Violet

1. In the Violet Connect onboarding tool, select **Shoptet** as your platform, then choose **Premium**.
2. Enter your **Eshop URL** and click **Next**.
3. Paste the **Private API Token** from Step 1 into the **Private API Token** field.
4. Submit the form. Violet will immediately validate the token by calling Shoptet's `GET /api/eshop` endpoint. If the token is valid, you will be redirected to the next step of onboarding; if it is rejected, you will see an error message and can retry with a corrected token.

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

### Premium Credential Summary

| Credential        | Required | Where to find it                              | Example                                |
| ----------------- | -------- | --------------------------------------------- | -------------------------------------- |
| Private API Token | Yes      | Shoptet admin › **Connections › Private API** | `1a2b3c4d-5e6f-7890-abcd-ef1234567890` |
| Eshop URL         | Yes      | Shoptet admin › **Settings › Basic settings** | `https://yourstore.myshoptet.com`      |

***

## Standard Tier

Standard tier is for merchants who do not have Private API access. Instead of an API token, you provide a product feed URL that Violet uses to sync your catalog.

### Step 1: Locating Your Eshop URL

1. Your Shoptet eshop URL is the public storefront address that customers use to reach your store (e.g. `https://yourstore.myshoptet.com` or your own custom domain).
2. You can confirm the exact URL in your Shoptet administration under **Settings › Basic settings**, or simply copy it from your browser address bar while viewing the storefront.

### Step 2: Locating Your Product Feed URL

1. In your Shoptet administration, navigate to the feed export settings for your store.
2. Copy the URL of your product feed (typically an XML feed URL, e.g. `https://yourstore.myshoptet.com/feed/products.xml`).
3. Ensure the feed is publicly accessible — Violet will periodically fetch this URL to sync your product catalog.

{% hint style="info" %}
If you are unsure where to find your product feed URL, check your Shoptet administration under feed or export settings, or contact Shoptet support for guidance.
{% endhint %}

### Step 3: Provide Details to Violet

1. In the Violet Connect onboarding tool, select **Shoptet** as your platform, then choose **Standard**.
2. Paste your **Store URL** from Step 1 into the **Store URL** field.
3. Paste your **Product Feed URL** from Step 2 into the **Product Feed URL** field.
4. Submit the form.

No credential validation is performed for standard tier — Violet will accept the URLs and begin syncing your catalog from the feed. Upon success you will be redirected back to the channel who first sent you to Violet.

### Standard Credential Summary

| Field            | Required | Where to find it                              | Example                                             |
| ---------------- | -------- | --------------------------------------------- | --------------------------------------------------- |
| Store URL        | Yes      | Shoptet admin › **Settings › Basic settings** | `https://yourstore.myshoptet.com`                   |
| Product Feed URL | Yes      | Shoptet admin › feed/export settings          | `https://yourstore.myshoptet.com/feed/products.xml` |

### Standard Tier Limitations

Standard tier provides catalog sync only. The following features are **not available** on the standard tier:

* Real-time product updates via webhooks
* Order submission (checkout / direct order submission)
* Shipping rate calculation
* Live inventory tracking

If you need these capabilities, consider upgrading to a Shoptet Premium plan and connecting via the Premium tier flow above.

***

## Special Considerations

### Token Security (Premium only)

Shoptet's Private API Tokens grant **full read access to all data in your eshop**, including customers and orders. Treat the token like a password:

* Never share it outside of the secure Violet onboarding form.
* Do not embed it in client-side code, screenshots, or support tickets.
* If you suspect the token has been compromised, revoke it immediately (see below) and generate a new one.

### Token Expiration (Premium only)

Private API Tokens issued by Shoptet **do not expire**. There is no need to schedule periodic rotation, but you can rotate the token at any time by creating a new one in Shoptet, providing it to Violet, and then deleting the old one.

### Revoking Credentials (Premium only)

To revoke the token at any time:

1. Sign in to your Shoptet administration and navigate to **Connections › Private API**.
2. Locate the row for your Violet integration token.
3. Click the red **×** in the **Action** column to delete the token.

Once revoked, all subsequent Violet API calls to your store will fail with an authorization error. Generate and provide a new token to restore the integration.

### Alternative: Marketplace Addon Installation

For merchants who prefer not to manage tokens manually, Violet also supports installation as a Shoptet **marketplace addon**. When this option is available, you can install Violet directly from the Shoptet Addon Store and authorization is handled automatically via OAuth — no token generation required. Reach out to Violet support to check availability of the addon for your region.


---

# Agent Instructions: 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:

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

The question should be specific, self-contained, and written in natural language.
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.