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

# Ecwid

This guide is intended for Ecwid merchants who are connecting their store to Violet. During the connection process, the merchant will install the Violet app through their Ecwid dashboard. Upon completion Ecwid will automatically provide Violet with the access keys required to sync with the merchants store. *Total time for completion is around 2 minutes.*

## Prerequisites:

A merchant must have a minimum Ecwid plan of `Venture` to be able to connect with Violet.

## Step 1: Installing the Violet App

1. From Violet Connect select Ecwid as your platform.
2. Click **Continue**. You will be redirected to Ecwid.
3. Click the **Accept** button to accept the required access scopes.
4. The Violet app will now be installed and the embedded app experience will load. You are now successfully connected to Violet.

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

### Refunds

As there is no concept of refunds in the Ecwid API, Violet is unable to be notified of refunds or access any refund data. As a temporary workaround, you will need to perform *one* of the following steps.

**Option 1: Mark Order as Cancelled**\
This option requires the least amount of effort. Simply mark any Violet orders as `cancelled` when the order is refunded and Violet will treat it as a refund.

**Option 2: Notify Violet of Refunds**\
This option will likely require the involvement of your engineering team. When a refund occurs, you will need to send information about the refund to Violet so that it can process the refund accordingly. If you choose this option, the integration documentation will be shared with you by Violet or the channel that onboarded you.

The Ecwid platform, as a rule, does not allow for an order placed via the API, as Violet does, to be refunded in the same way that an order placed on the storefront may be refunded.\
This means that for Violet Orders, the Ecwid interface refund button that can typically be used to start a refund is not able to be used.

Instead, simply mark any Violet orders as `refunded` or `cancelled` when the order is refunded and Violet will treat it as a full refund.

## Information for Managed Stores

In the situation where the merchant does not manage their own store but works with a management agency, here is the configuration information to pass on to the agency:

**Webhook URL**: <https://api.violet.io/v1/sync/external/events/ecwid>

**Webhooks Topics**:

* Order (updated, deleted)
* Product (created, updated, deleted)
* Store profile (updated, subscription plan updated)
* Application (subscription status updated, uninstalled)

**Scopes**:

* read\_store\_profile
* read\_store\_limits
* read\_catalog
* read\_orders
* update\_orders
* create\_orders
* read\_customers
* create\_customers
* read\_discount\_coupons

{% hint style="warning" %}
Merchants must have 3rd party cookies enabled and any ad-blockers or browser shields in their browser disabled when using Ecwid. It is recommended that these actions are taken before they begin the connection process.
{% endhint %}


---

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