# Overview

## Welcome to Violet Merchant Help

Welcome to Violet's comprehensive merchant documentation center. Whether you're just getting started or need help managing your existing integration, you'll find everything you need to successfully connect your store and maximize your cross-platform selling potential.

### Getting Started

#### New to Violet?

If you're here because a channel partner invited you to connect your store, you're in the right place. Violet makes it easy to expand your reach by selling through multiple channels while maintaining control of your inventory, pricing, and customer relationships.

**Start Here:** [Understanding Violet Connect](#violet-connect-onboarding)

#### Already Connected?

If you've already completed onboarding and need help managing your integration, jump straight to:

* [Merchant Dashboard Guide](#merchant-dashboard)
* [Order Management](#order-management)
* [Troubleshooting](#troubleshooting)

***

### Platform Integration Guides

Choose your e-commerce platform to get started with a step-by-step integration guide:

#### Popular Platforms (5-10 minutes setup)

| Platform                                                                        | Setup Time  | Key Features                                   |
| ------------------------------------------------------------------------------- | ----------- | ---------------------------------------------- |
| [**Shopify**](https://merchant-help.violet.io/platform-guides/shopify)          | \~5 minutes | Custom App creation, comprehensive API access  |
| [**BigCommerce**](https://merchant-help.violet.io/platform-guides/big-commerce) | \~5 minutes | Store-level API account, native coupon support |
| [**WooCommerce**](https://merchant-help.violet.io/platform-guides/woo-commerce) | \~5 minutes | Plugin installation, WordPress integration     |

#### Enterprise Platforms (15-30 minutes setup)

| Platform                                                                                                   | Setup Time   | Key Features                                 |
| ---------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------------------- |
| [**Salesforce Commerce Cloud**](https://merchant-help.violet.io/platform-guides/salesforce-commerce-cloud) | \~20 minutes | OCAPI + SCAPI configuration, customer groups |
| [**Magento**](https://merchant-help.violet.io/platform-guides/magento)                                     | \~15 minutes | API user creation, scope configuration       |
| [**CommerceTools**](https://merchant-help.violet.io/platform-guides/commercetools)                         | \~20 minutes | Project-level API client setup               |

#### Additional Supported Platforms

* [**Prestashop**](https://merchant-help.violet.io/platform-guides/prestashop) - API key generation and webhook setup
* [**Swell**](https://merchant-help.violet.io/platform-guides/swell) - Store API configuration
* [**Spree**](https://merchant-help.violet.io/platform-guides/spree) - OAuth application setup
* [**Vendo**](https://merchant-help.violet.io/platform-guides/vendo) - API credentials and webhook configuration
* [**Ecwid**](https://merchant-help.violet.io/platform-guides/ecwid) - App installation and token generation
* [**Wix**](https://merchant-help.violet.io/platform-guides/wix) - Business Solutions integration
* [**Squarespace**](https://merchant-help.violet.io/platform-guides/squarespace) - Commerce API setup
* [**Shoprenter**](https://merchant-help.violet.io/platform-guides/shoprenter) - API Credentials setup

> **Note:** Each platform guide includes platform-specific requirements, step-by-step setup instructions, and troubleshooting tips.

***

### Violet Connect Onboarding

Violet Connect is our streamlined merchant onboarding process that walks you through connecting your store in just a few minutes.

#### What You'll Need

* Access to your e-commerce platform's admin dashboard
* Administrator permissions to create API credentials
* Email address for account creation
* Banking information for payout setup (if using Violet Payments)

#### Onboarding Steps

1. **Platform Selection** - Choose your e-commerce platform
2. **Store URL Entry** - Provide your store's URL
3. **Credential Generation** - Follow platform-specific guide to create API credentials
4. **Credential Input** - Enter credentials in Violet Connect
5. **Payout Setup** - Connect your bank account via Stripe (if applicable)
6. **Commission Rate** - Set your agreed-upon commission rate
7. **Completion** - Get redirected back to your channel partner

#### After Onboarding

Once connected, you'll receive an email with:

* Login credentials for your Merchant Dashboard
* Summary of your connection settings
* Next steps for managing your integration

***

### Merchant Dashboard

Your Merchant Dashboard is your central hub for managing all aspects of your Violet integration.

**Access:** [merchant.violet.io](https://merchant.violet.io)

#### Dashboard Sections

**Overview**

* View connected store information
* See all connected channels
* Manage commission rates by channel
* Monitor connection health

**Orders (Bags)**

* View all orders placed through Violet
* Track order status and fulfillment
* Filter by channel, date, or status
* Export order data

**Catalog (Offers)**

* View all synced products
* Publish/unpublish products by channel
* Filter by availability, status, and tags
* Manage product visibility

**Payouts**

* Review payout history and status
* Track distributions across orders
* Manage payout account settings
* View commission earnings by channel

**Communication**

* **Messages:** Direct communication with channels
* **Notifications:** System alerts and updates
* **Commission History:** Track rate changes over time

***

### Order Management

#### Order Lifecycle

1. **Order Placement** - Customer places order through channel
2. **Order Sync** - Order appears in your e-commerce platform
3. **Fulfillment** - You fulfill the order as normal
4. **Status Updates** - Violet tracks fulfillment status
5. **Payout** - Commission is calculated and paid out

#### Key Considerations by Platform

**Shopify**

* When canceling orders, always select "Refund Payments NOW"
* Inventory syncs from all locations by default
* Currency conversion uses real-time rates unless presentment currencies are configured

**BigCommerce**

* Refunds show as "offline" - this is expected behavior
* Use Coupon Codes (not Promotions) for discount integration
* Multi-currency pricing supported through contextual pricing

**Salesforce Commerce Cloud**

* Orders require special customer group (VIOLET\_API)
* Payment method configuration needed (VIOLET\_API)
* Refund notifications may require engineering integration

***

### Troubleshooting

#### Common Connection Issues

**"Store URL Invalid" Error**

* **Shopify:** Check for multiple domains in Settings → Domains, use the primary domain
* **All Platforms:** Ensure URL includes `https://` protocol
* **Verification:** URL should match what appears in your admin dashboard

**Credential Validation Failures**

* Double-check for copy/paste errors and extra spaces
* Ensure all required scopes/permissions are enabled
* Verify credentials haven't expired or been regenerated
* Check that API quotas haven't been exceeded

**Missing Shipping Rates**

* Configure shipping zones for all target markets
* Ensure products have weight/dimensions configured
* Verify shipping methods are enabled for your regions
* Check for location-based shipping restrictions

#### Platform-Specific Issues

**Shopify**

* **Minimum Plan:** Requires Shopify Basic or higher
* **API Notices:** Ignore Shopify API deprecation notices - Violet handles updates
* **Inventory Sync:** Contact support if you need location-specific inventory filtering

**BigCommerce**

* **Offline Refunds:** Expected behavior for Violet orders
* **Coupon Issues:** Use Coupon Codes, not Promotions
* **Currency:** Enable presentment currencies for multi-currency support

**WooCommerce**

* **Plugin Issues:** Ensure WordPress/WooCommerce versions are current
* **Hosting:** Verify hosting provider allows external API connections
* **Permissions:** Check file permissions if plugin installation fails

***

### Advanced Features

#### Multi-Currency Support

* **Default:** Real-time currency conversion
* **Enhanced:** Presentment currency pricing (requires setup)
* **Configuration:** Contact your channel partner to enable

#### Inventory Management

* **Single Location:** Automatic inventory sync
* **Multiple Locations:** Combined inventory by default, filtering available
* **Real-time Updates:** Inventory changes sync automatically

#### Commission Management

* **Flexible Rates:** Set different rates per channel
* **Rate Changes:** Update anytime through dashboard
* **History Tracking:** Full audit trail of rate changes
* **Locking:** Channels can lock rates via API if pre-negotiated

***

### Getting Help

#### Self-Service Resources

* **Platform Guides:** Step-by-step integration instructions
* **Dashboard Guide:** Complete merchant dashboard walkthrough
* **API Documentation:** Technical reference for developers
* **FAQ Section:** Answers to common questions

#### Direct Support

* **Channel Partner:** Your primary point of contact for business questions, technical issues and platform-specific help
* **Merchant Dashboard:** Use Messages tab to communicate with channels
* **Documentation:** AI-powered search (Ctrl/Cmd + K)

#### Emergency Issues

For urgent technical issues affecting order processing:

1. Contact your channel partner immediately
2. Check Violet status page for system-wide issues
3. Use Merchant Dashboard to temporarily unpublish affected products
4. Monitor order queue for processing delays

***

### Next Steps

#### If You're Just Getting Started

1. **Choose your platform** from the integration guides above
2. **Follow the step-by-step guide** for your platform
3. **Complete Violet Connect onboarding** with your credentials
4. **Test your integration** with a sample order
5. **Explore your Merchant Dashboard** to familiarize yourself with the tools

#### If You're Already Connected

1. **Bookmark your Merchant Dashboard** for easy access
2. **Review your commission rates** across all channels
3. **Set up order notifications** to stay informed
4. **Explore catalog management** to optimize product visibility

#### Ready to Scale

1. **Connect additional channels** through the same process
2. **Optimize your product data** for better discoverability
3. **Monitor performance metrics** in your dashboard
4. **Consider advanced features** like presentment currencies

***

*This documentation is continuously updated. For the latest information and new platform integrations, check back regularly or contact your channel partner.*
