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.

​

Special Refund Considerations

Beyond the usual process for refunding an order this platform has special limitations and considerations that need to be kept in mind when interacting with orders from Violet:

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