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

# Ecwid

Overview of Violet's Ecwid (Lightspeed eCom) integration for channel developers

Ecwid (now part of Lightspeed) is a hosted ecommerce platform that can be embedded into existing websites. Violet integrates via Ecwid's REST API using OAuth-based authentication.

## Connection

Ecwid uses an OAuth app flow. The merchant authorizes Violet's app installation, and Violet receives an access token along with the merchant's Store ID. Merchants must be on the **Venture plan or higher** for API access.

### Required OAuth Scopes

The following scopes are required for the Violet integration to function:

| Scope                   | Purpose                     |
| ----------------------- | --------------------------- |
| `read_store_profile`    | Access store configuration  |
| `read_catalog`          | Sync product catalog        |
| `read_orders`           | Read order data             |
| `update_orders`         | Update order status         |
| `create_orders`         | Submit new orders           |
| `create_customers`      | Create customer records     |
| `read_customers`        | Read customer data          |
| `read_discount_coupons` | Access coupon/discount data |

Violet validates that all required scopes are granted during authentication.

## Webhooks

Webhooks are registered automatically via the Ecwid API when a merchant connects. Violet listens for product and order events to keep the catalog and order status in sync.

## Notable Behavior

* **Plan requirement**: The Ecwid Venture plan or higher is required for REST API access. Merchants on the Free or Venture plan may have limited API capabilities.
* **Discount codes**: Ecwid coupon/discount codes are supported for order submission.
* **Store URL**: The store's canonical URL is retrieved from the merchant's Ecwid profile during connection.


---

# 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://docs.violet.io/ecom-platforms/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.