For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

Last updated

Was this helpful?