This guide is intended for Wix merchants who are connecting their store to Violet. During this process, the merchant will create a new API Key in their Wix dashboard and then provide the generated credentials to Violet through the Violet Connect onboarding tool. The merchant will retain full control of the created API Key and can remove it at any time from within their Wix dashboard. Total time for completion is around 3 minutes.

Step 1: Creating App Credentials

  1. Within your Wix admin dashboard navigate to the Account Settings page. This can be done by clicking on your profile image in the upper right corner of the Wix dashboard and then selecting Account Settings from the menu.
  2. From the Account Settings page click on Api Keys from left sidebar. This page link is generally the last option in the left sidebar menu.
  3. Click the Generate API Key in the upper right corner of the API Keys page.
  4. Enter a Name for the new API Key that will remind you of the reason for creating this client. This can be as simple as “Violet” or the name of the channel you are connecting to.
  5. In the Scopes section ensure that each of the following boxes are checked.
    1. Basic permissionsGet Sites List
    2. All account permissionsManage Sites
    3. All site permissionsWix Stores
    4. All site permissionsWix Currencies
    5. All site permissionsBusiness Info
  6. Click the Save & Close button. Your API Key will now be created.
  7. A modal will appear with your API Key. Copy this token and keep it available for Step 2 of this guide. Once you close the screen with the key you will no longer be able to see it again.
  8. Once you close the API Key screen you will be returned to the API Keys page that lists your tokens. On the right side of this screen you will find the Account ID section. Copy the Account ID and keep it available for Step 2 of this guide.
  9. Next go to the Home screen of your Wix Dashboard. This can be done by clicking on the Wix logo in the upper left corner of the Wix Dashboard.
  10. Once you are on the Home screen, the URL in your browser will contain your Site ID between /dashboard/ and /home. In this example URL,, 83799f16-12a9-4803-963e-ed6fed6c7e4d is the Site ID. Copy this value and keep it available for Step 2 of this guide.

Step 2: Provide App Credentials to Violet

Once you have your Client ID and Client Secret, it’s time to return to the Violet Connect onboarding tool and enter the follow credentials created in the previous steps:

  1. Enter your API Key obtained in the previous steps in the ”API Key” field.
  2. Enter your Account ID obtained in the previous steps in the ”Account ID” field.
  3. Enter your Site ID obtained in the previous steps in the “Site ID” field.

Once entered, click the Connect button to validate the credentials and complete the connection between your store and Violet. If the credentials are invalid you should check for any spaces or other copy/paste errors and try again.

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

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 below ONLY applies to orders placed before 2024-04-22. All orders placed afterward can be refunded via the standard process.

See our release notes for more details.

The Order API on the WIX platform is currently in its early stages and comes with certain limitations concerning order refunds.

Consequently, it is essential to carefully follow these specifics steps to ensure a comprehensive and successful refund for your customers.

Unfulfilled Order

In the event that an order is still undergoing processing and has not yet been shipped, initiating a refund can be accomplished by canceling the order.

Step 1: Go to Actions Cancel Action

Step 2: Cancel Order Cancel Order

Step 2.5: Confirm Cancel Cancel Order

Previously Fulfilled Order

Once an order has been dispatched, it is necessary to unfulfill it before you can proceed with initiating a refund by canceling the order.

Step 1: Go to Actions Unfulfill Action

Step 2: Unfulfill Order As soon as you select the option Mark as fulfilled, the order status will promptly be updated to UNFULFILLED. You can see this below: Unfulfilled Status

Step 3: Follow Steps from Unfulfilled Order above.