The Violet API provides developers with access to two environments - sandbox and live. From the experience of the developer, these environments are nearly identical with only two primary differences.

When first created your app will be limited to the Sandbox environment. This allows you to build and fully test out your application without the risk of transacting real dollars. The sandbox product catalog provides you with a few thousand products across multiple taxonomies and complexities. These test products do live on private stores on real e-commerce platforms (ex. Shopify, Ecwid, etc) so you will be able to fully validate that your requests are working just as they would when using the live environment.

When applying a payment method to an order in the sandbox environment you will need to use a test credit card number.

When your application has been approved you will gain access to the live environment. The live environment provides a developer with access to the live catalog of products. These are products associated with real stores where successful purchases result in true order fulfillment. The live product catalog is constantly growing. Each time a new merchant joins Violet, the catalog increases in size.

When making purchases against the live environment true credit card numbers, or real oAuthed customers (coming soon), are required. The test credit card numbers available in sandbox will not work when making requests against the live API.

You can request Violet to review your application to make it live by sending us an email at 

. Access to the Live environment is granted upon the successful review of a developers application. If the business model and application quality meet our requirements a developers Live API credentials will be enabled.

Environments

Apps

Violet

Create a Violet Application

Postman + Login

View Merchants

Interact with Catalogs

Place an Order

Quick Start

Utilizing Quick Checkout

Welcome to Violet's Docs

Definitions

Obtaining an API Token

Refreshing an API Token

Authentication

Pagination

Get Merchants

Get Connected Merchants

Get Merchant Information by Id

Merchants

Product Offers

Products by ID

Product Search

Product Filtering

Get Categories

Search Categories

Get SKU information by ID

Catalog

Carts and Bags

Create a Cart

Add Item to Cart

Apply Customer to Cart

Apply Address to Cart

Retrieve and Apply Shipping Methods

Apply Payment Method to Cart

Price Cart

Submit Cart

Order Errors

Checkout

Managing Webhooks

Managing Webhook Headers

Simulating Webhooks

Webhook Events

Webhooks

Payments and Payouts

Connect a Merchant

Violet Connect - BigCommerce

Violet Connect

Current Platforms

Concepts

Login

Refresh Token

Access

Get Products

Get Random Products

Get Product by ID

Search Products

Catalog - Products

Get Sku by ID

Catalog - Skus

Get Offer by ID

Catalog - Offers

Get Category by Slug

Get Category by ID

Get Category Tree

Catalog - Categories

Create Cart

Get Cart by Token

Get Cart by ID

Delete Cart

Checkout - Cart

Add SKU to Cart

Update SKU in Cart

Remove SKU from Cart

Checkout - Items

Update Billing Address

Set Billing Address

Apply Guest Customer to Cart

Update Shipping Address

Set Shipping Address

Checkout - Customer

Set Shipping Methods

Get Available Shipping Methods

Remove Shipping Method

Checkout - Shipping

Get Stripe Public Token

Apply Payment Method

Checkout - Payment

Checkout - Completion

Search Orders

Get Orders

Get Order by ID

Orders

Get Webhook Event Body

Get Webhook Event

Get Webhook Event Types

Get All Webhook Events

Get Webhook Events

Events - Webhook Events

Get Webhook Headers

Create Webhook Header

Get Webhook Header

Update Webhook Header

Delete Webhook Header

Events - Webhook Headers

Get Webhook

Update Webhook

Delete Webhook

Get Webhooks

Create Webhook

Delete Channel Webhooks

Update Webhooks Status

Events - Webhooks

API Reference

Where am I?

Support

Security

Changelog

Environments

Overview

Sandbox

Live