Welcome

API Reference

Violet

Get API Keys

Violet Documentation

Channel Docs

Merchant Docs

Book a Demo

Blog

Contact Us

Welcome to Violet! We're glad you're here.

Welcome to Violet

Welcome to Violet's Docs

Definitions

Apps

Authentication

Obtaining an API Token

Refreshing an Auth Token

Overview

Catalog Overview

The Offer Search API lets you search across offers from all merchants that you are connected to within the Violet network and provides robust filter criteria that you can use to power your gallery.

Offer Search

A Product Offer is a merchant's offering of a product. Since multiple merchants can be selling the same product, Violet provides you with each of the offers so that you can choose which suits your system best. 

Product Offers

Get all information about an individual Product such as description, brand, offers, related SKUs, variations, etc.

Products by ID

The product search resource enables you to discover the products available to you within the Violet product catalog. Using any of the filter criteria described below, you can retrieve information on products that match that criteria. 

Product Search

The product filtering resource enables you to filter against a list of products. This endpoint behaves very much like product search, however instead of searching for and filtering against new products, you are filtering a specified list of products. This API comes in handy when you're filtering against products of a certain category, since there can be thousands of products that meet your criteria. 

Product Filtering

Each product belong to a predefined Category. You can access all available Categories for products using the Get Categories API, which returns a list of categories products from merchants you have access to belong to. 

Get Categories

Given certain criteria, you may only want to show Categories of products that match these critera. With the Search Categories API you can filter for categories based on a filter query. 

Search Categories

When choosing an item for an order, you may want to retrieve all information related to that specific variation of that product. You can do this by passing in the SKU of the product and retrieving all information related to that SKU. 

Get SKU information by ID

Media Transformations

Checkout Overview

Carts and Bags

Cart creation begins the checkout process. An empty cart with no products can be created, or a cart prefilled with items can be created for your shopper. 

Create a Cart

Once a cart has been created you can begin adding items to it. Items are added by their SKU ID. SKUs can be found by searching the product catalog, and then selecting the desired SKU of the desired offer.

Add Item to Cart

Once items are added to a cart, it's possible to add discounts to it.

Add Discount to Cart

This API lets you apply customer information to the cart. The primary purpose of the customer data is to provide the merchant with enough information to communicate with the customer once the order has been submitted.

Apply Customer to Cart

Addresses are required for merchants to determine where to ship the orders to. Both shipping and billing addresses are required by merchants to execute an order. 

Apply Address to Cart

Shipping methods are required for merchants to determine how to deliver the order to the shopper. Shipping methods are chosen by the shopper.

Retrieve and Apply Shipping Methods

There are currently two methods for applying a guest payment method to a cart. The first method is to apply a generated payment token where the card data was tokenized before sending it to Violet. The second method is to send raw card data directly to Violet.

Apply Payment Method to Cart

Once your cart has been fully populated and you’re ready to collect the cart totals you can price the cart. This request will calculate your subtotal, shipping total, tax total, and grand total.

Price Cart

When you cart is ready for submission you can request confirmation from the shopper and submit the order.

Submit Cart

Order Errors

Rate Limits

Utilizing Quick Checkout

Discounts: Using a Code

Commission Rates

Currencies

Current Platforms

Environments

Merchants

With the Get Merchants API, you can retrieve a list of all merchants your application has access to. You can choose from this list what you would and wouldn't like to connect to.

Get Merchants

With the Get Connected Merchants API, you can retrieve the list of Merchants that your Violet application is already connected to.

Get Connected Merchants

Merchants have a lot of specific information you may need for your application such as default currency, platform, shipping details, etc. You can retrieve merchant details through the Get Merchant Info By ID API. 

Get Merchant Information by Id

Merchant Parity

Pagination

Payments and Payouts

Violet Checkout with Apple Pay

Violet Checkout with Stripe.js v3

Statement Descriptors are the text a shopper sees on their credit card statement after a purchase is made from your experience. This is one of the many different things used to qualify a Merchant of Record (MoR). You can read more about this [here](https://www.venable.com/insights/publications/2019/05/will-the-real-merchant-of-record-please-stand-up).

Transaction Statement Descriptors

Webhooks

Managing Webhooks

Managing Webhook Headers

Simulating Webhooks

Webhook Events

Libraries and tools to interact with your Violet integration. 

Violet Packages & SDKs

Express Proxy Server

React Violet.js

Violet iOS SDK

Violet Connect

Connect a Merchant

Violet Connect - Your BigCommerce App

Access real-time data in external commerce platforms

Relay

Get Offers

Get Orders

Quickstart

Create a Violet Application

Postman + Login

Violet Sample App — The Ultra Store

Learn about Violet's latest integrations and features

Change Log

Integration Guide

Shipping Configuration Requirements

Shopify Merchant Shipping Configuration Requirements for Violet

BigCommerce

WooCommerce

Magento

Prestashop

Salesforce Commerce Cloud

Swell

Spree

Vendo

Ecwid

Login

Refresh Token

Get All Merchant Offers

Get Offer by ID

Search Offers

Get Sku by ID

Get Category by ID

Get Category by Slug

Get Category Tree

Currency Exchange Rates

Get Cart by ID

Delete Cart

Create Cart

Get Cart by Token

Apply Payment Method

Update Payment Transaction

Apply Guest Customer to Cart

Set Shipping Address

Update Shipping Address

Set Billing Address

Update Billing Address

Get Order Refunds

Get Bag Refunds

Get Order Refund by ID

Set Shipping Methods

Remove Shipping Method

Get Available Shipping Methods

Remove Discount from Cart

Add SKU to Cart

Remove SKU from Cart

Update SKU in Cart

Get Order by ID

Search Orders

Search Bags

Get Merchant

Search Merchants

Get Merchant Summaries

Get All Webhooks

Create Webhook

Delete All Webhooks

Update Webhooks Status

Get Webhook

Update Webhook

Delete Webhook

Get All Webhook Events

Get Webhook Event Types

Get Webhook Events

Get Webhook Event

Get Webhook Event Body

Get Webhook Headers

Create Webhook Header

Get Webhook Header

Update Webhook Header

Delete Webhook Header

ConnectionHealth reports are cached once every 24 hours, if you need to request fresh data, pass ?refresh=true.

Get Connection Health Report

Get Custom Connection Health Report

Get Connection Health

Overview

Login

Catalog

Orders & Checkout

Merchants

Events

Operations

API Reference

Overview

Login

Catalog

Orders and Checkout

Merchants

Events

Operations

Overview

Login

Catalog

Orders & Checkout

Merchants

Events

Operations

​Overview

Login

Catalog

Orders and Checkout

Merchants

Events

Operations

Overview