Violet Documentation

Welcome to Violet

Apps

Pagination

Environments

Definitions

Overview

Current Platforms

Payments

Violet Connect

Follow these steps to get your Channel ready to connect merchants

Setup

Payouts

Commissions

FAQs

Access real-time data in external commerce platforms

Relay

Webhooks

Learn about Violet's latest integrations and features.

Change Log

Support Requests

Security

Violet SLA

Welcome

API Reference

BigCommerce

WooCommerce

Magento

Prestashop

Salesforce Commerce Cloud

Swell

Spree

Vendo

Ecwid

CommerceTools

Squarespace

Merchant Dashboard

Refunding a Violet Order is the same as any other order

Refunding An Order

Refunding A Violet Order

From the merchants system, canceling a Violet Order is the same as canceling a traditional order.

Canceling an Order

Get API Keys

Documentation

Merchant Guides

Book a Demo

Blog

Contact Us

Obtaining an API Token

Refreshing an Auth Token

Getting Started

Create a Violet Application

Postman + Login

Merchants

Merchant Parity

Merchant Enabled/Disabled

Catalog Data in Violet

Offers

SKUs

Collections

Metadata

Media Transformations allow you to resize offer media dynamically in the cloud, saving bandwidth and page load time when rendering PDPs

Media Transformations

Contextual Pricing

Carts and Bags

Customers

Shipping Methods

Discounts

Applying and Removing Discounts

Webhook Headers

Webhook Events

Simulating Webhook Events

Handling Webhooks

Rate Limits

Utilizing Quick Checkout

Checkout with Stripe.js V3

Violet Checkout using Apple Pay, Google Pay and other supported wallets

Checkout with Apple Pay or Google Pay

Direct Order Submission

Submitting a Direct Order

Tax Remittance

Understanding Tax Remittance Responsibility

Catalog

Catalog FAQs

Checkout

Checkout FAQs

Discounts FAQs

Distributions

Distributions FAQs

Login

Login FAQs

Payments FAQs

Resources

Channel Dashboard

Violet Web Sample App

Express Proxy Server

Stripe Scopes

Required Stripe Scopes for Payment Orchestration

Bypassing Payments

Bypassing Violet Payments

Capture Settings

Transfer Settings

Tax Remitter Settings

Country-Specific Restrictions

Fee Structure

Payment Transactions

Capture and Transfer Methods

Supported Currencies

Commission Rates

Supported Countries

Stripe KYC Guide

Export

Payouts Export

Available Columns

Payout Columns Available to Export

Violet Connect Step-by-Step

Connection Health

Detecting Merchant Connections

Connecting your BigCommerce App

We encourage channels to create free test stores they can own and manage and then connect those test stores to their test mode channel. This will allow you to manage your own test products, initiate test refunds/returns for your orders and get some experience working with Violet Connect before you start onboarding real merchants.

Connecting a Test Shopify Store

Fetching Offers

Fetching Offers From a Platform

Fetching Orders

Fetching Orders From a Platform

Fetching Collections

Fetching Collections From a Platform

Fetching Shipping Zones

Fetching Shipping Zones From a Platform

Integration Guide

Shipping Configuration Requirements

Shopify Merchant Shipping Configuration Requirements for Violet

Setting up a Payout Account

Managing Payout Accounts in the Merchant Dashboard

Understanding Payouts and Distributions

Tracking Your Payouts and Distributions

Connecting a new Stripe Account for Payouts

Auth tokens expire after 24 hours, you many use this endpoint to pass the refresh token in to mint a new auth token.

Refresh Token

Get Merchants

Get Merchant

Search Merchants

Get Merchant Config

Toggle Global Feature Flag

Modify Merchant Order Config

Get All Merchant Offers

Get Count of Merchant Offers

Get Offer by ID

Search Offers

Get Sku by ID

Get Categories

Get Category by ID

Get Category by Slug

Get Category Tree

Search Categories

Retrieve a list of all `Collection`s that you have access to.

Get All Collections

Retrieve a list of all `Collection`s for a given `merchant_id`.

Get All Merchant Collections

Retrieve the `Collection`s details for a given `collection_id`.

Get Collection by ID

Retrieve a list of all `Offer`s inside a `Collection` for a given `collection_id`.

Get Collection Offers

Retrieve a list of all `Offer`s IDs inside a `Collection` for a given `collection_id`.

Overview

Login

Merchants

Catalog

Orders & Checkout

Events

Apps

Operations

Relay

Ecom Syncs

Update billing address