Overview

Violet API Reference

Overview

The Violet API is organized around the REST protocol.

Using our API, you'll be able to perform a variety of operations, such as performing Checkout or Bi-directional Data Transfers across a multitude of E-commerce platforms.

Key Sections

• Login – Login and Auth capabilities powered by Violet

• Catalog – Easily access Catalog data for all your connected merchants

• Orders and Checkout – Power multi-merchant Checkout through Violet

• Merchants – Access information about your connected merchants

• Events – Track the lifecycle of Orders and Checkout through events

• Operations – Understand the health of merchants connected to your platform

OpenAPI Files

The Violet OpenAPI files are available on GitHub. These files describe the APIs Violet exposes in a standardized way suitable for usage with tools for testing, client library generation, and other purposes that ingest OpenAPI/Swagger definition files. By default, Violet generates open-api-3 spec files.

A Note About Null Values

As a general rule, values that are null will not be included in the response object. So if a property listed in the spec is not being returned by the API it is usually because that property is null for the returned object.