Get API Keys

Violet Documentation

Documentation

API Reference

Merchant Guides

Book a Demo

Blog

Contact Us

Currency Exchange Rates

Retrieves the latest currency exchange rates that are currently being utilized within Violet when calculating the prices of Offers and Carts with differing currencies. Retrieved exchange rates are cached. This cache will never exceed 24 hours.

Welcome to Violet

Apps

Pagination

Overview

Obtaining an API Token

Refreshing an Auth Token

Environments

Definitions

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

Carts and Bags

Customers

Shipping Methods

Discounts

Applying and Removing Discounts

Payments

Connecting a Stripe Platform Account

Connecting a Stripe Platform Account To Violet

Fee Structure

Payment Transactions

Custom Transfers

Supported Currencies

Migrating Stripe Accounts

Commission Rates

Supported Countries

Stripe KYC Guide

Export

Payouts Export

Available Columns

Payout Columns Available to Export

Webhooks

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

Bypassing Payments through Violet

Direct Order Submission

Submitting a Direct Order with a Payment Method

Catalog

Catalog FAQs

Checkout

Checkout FAQs

Discounts FAQs

Distributions

Distributions FAQs

Login

Login FAQs

Payments FAQs

Resources

Channel Dashboard

Merchant Dashboard

Violet Web Sample App

Express Proxy Server

Stripe Scopes

Required Stripe Scopes for Payment Orchestration

Current Platforms

Violet Connect

Follow these steps to get your Channel ready to connect merchants

Setup

Payouts

Commissions

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

FAQs

Access real-time data in external commerce platforms

Relay

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

Learn about Violet's latest integrations and features.

Change Log

Support Requests

Security

Violet SLA

Integration Guide

Shipping Configuration Requirements

Shopify Merchant Shipping Configuration Requirements for Violet

BigCommerce

WooCommerce

Magento

Prestashop

Salesforce Commerce Cloud

Swell

Spree

Vendo

Ecwid

CommerceTools

Squarespace

Payouts and Distributions

Understanding Payouts and Distributions

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

Welcome

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`.

Get Collection Offers IDs

Create Cart

Get Cart by ID

Delete Cart

Add SKU to Cart

Update SKU in Cart

Remove SKU from Cart

Apply Customer to Cart

Set Shipping Address

Set Billing Address

Add Discount to Cart

Remove Discount from Cart

Get Available Shipping Methods

Set Shipping Methods

Remove Shipping Method

Price Cart

Estimate Cart

Apply Payment Method

Update Payment Transaction

Submit Cart

Create Order

Get Orders

Get Order by ID

Search Orders

Search Bags

Refund Bag

Get Order Refunds

Get Bag Refunds

Get Order Refund by ID

Cancel Order

Cancel Bag

Get Order Cancellations

Process Transfers for a single Order

Process Transfers for a single Bag

Process Transfers for Orders

Process Transfers for Bags

Get Webhooks

Creates a new webhook for the desired event. The remote endpoint must be HTTPS.

Create Webhook

Deletes All Channel Webhooks. Events will immediately stop posting to this endpoint upon deletion.

Delete Channel Webhooks

Update Webhooks Status

Overview

Login

Merchants

Catalog

Orders & Checkout

Events

Apps

Operations

Relay

Ecom Syncs

Currency Exchange Rates

Headers

Query Parameters

Response