Delete Cart

Violet

X-Violet-Token

X-Violet-App-Secret

X-Violet-App-Id

cart_id

Exchange rate of currency and external currency, if different, at the time the bag was last priced.

Currency of cart on external ecommerce platform

ID of the Order on the External Ecommerce Platform

The commerce platform used by this merchant.

Date when the bag can no longer be refunded

Is this bag going to be placed through wallet-based checkout

ID of the bag the fulfillment belongs to.

ID of the Bag the fulfillment belongs to.

ID of the fulfillment on the external commerce platform.

Raw name of carrier from the external commerce platform.

ID of the fulfillment that contains this item.

Quantity of the this item fulfilled by this fulfillment.

The ID of the bag the Shipping Method belongs to

Optional data to initialize the cart with on creation.

Map the order in Violet to an order record within your system

Associate the order with a user or affiliate in your system

Boolean denoting whether or not this order will be placed through a wallet based payment mechanism such as apple pay

Map the order in Violet to an order record within your system.

Transaction ID representing a transaction in the channels system.

ID of the Merchant the discount belongs to

The shipping or billing address of a user placing an order

Optional value used to represent an identifier in your system.

Stripe publishable key. Use for tokenizing payment methods.

Is this cart going to be placed through wallet-based checkout

ID of the Customer on the External Platform

ID of the User the Order Customer references

ID of the Bag the Shipping Method applies to

Is the product still available for purchase

ID of the SKU on the External Ecommerce Platform

Price of the SKU multiplied by the Quantity

The quantity of this item that has been fulfilled

The payment method request for a cart. If the token is provided no card data is required.

Expiration month of the credit or debit card.

Expiration year of the credit or debit card.

Submit cart immediately after applying the payment method.

Amount being taken back from the associated transfer to the developer

List of errors associated to this refund during processing.

ID of the refund on the external commerce platform.

ID of the Transaction in the Payment Gateway

Amount being taken back from the associated transfer to the merchant

Currency set for this refund by the external ecom platform

ID of the Refund this Error is associated to

Id of the Order Sku associated with Refund Order Sku

Quantity of the this item refunded by this refund.

Id of the Refund associated with Refund Order Sku

Order ID in the External Commerce Platform

Error Code from gateway if error occurred

ID of the Merchant receiving the transaction

ID of the Order the Transaction applies to

Violet.io

Order-Service

Get API Keys

Violet Documentation

Channel Docs

Merchant Docs

API Reference

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

Overview

Login

Catalog

Orders & Checkout

Merchants

Events

Operations

Delete Cart

Headers

Path Parameters

Response