Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Cart
- Items
- Customer
- Discounts
- Shipping
- Payment
- Completion
- Refunds
- Cancellations
- Orders
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Create Order
Order
Errors on the Order. During checkout, if there was an error or issue on one of the order's bags, there will be an error added to this list describing the issue. The checkout API will return 200 with the order object in the response even if there was an issue with a bag so you must always check the response for errors in this list to know if there was an issue on the order.
ID of the User placing the order
ID of the App creating the order
ID of the Developer who placed
The Customer Placing the Order
ID of the User the Order Customer references
First Name
Last Name
Email Address of Customer
ID of the Customer on the External Platform
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
Email Address
First line of the Address
Second line of the Address
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
Email Address
First line of the Address
Second line of the Address
Use Same Address for Both
Bags in the Order
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
Email Address
First line of the Address
Second line of the Address
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
Email Address
First line of the Address
Second line of the Address
Payment Method belonging to an Order
Brand of Card
Last Four Numbers on Card
Card Expiration Month
Card Expiration Year
Name as it appears on Card
ID of the referenced Payment Method
Is Default Method
The price of the Order in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.
The sum of all shipping methods applied to the Order in the base currency. In Cents.
The sum of all the taxes applied to the Order in the base currency. In Cents.
The total discounts applied to the price of the Order in the base currency. In Cents.
The sum of all item prices, discounts, shipping, and taxes applied to the Order in the base currency. In Cents.
App Customer ID. This should be used to map the order to the ID of the customer in your application.
App Order ID. This should be set to a unique identifier in your system. While not enforced unique in Violet's system, it is strongly recommended that unique values are used for each cart to help correlate identifiers between Violet's system and yours.
Status of the Order
Order is Guest
Date of order creation
Date of last order update
Is the cart priced
Is this cart going to be placed through wallet-based checkout
Base currency of cart
Optional value used to represent an identifier in your system. This value is not required to represent a referral. It can represent the ID of anything in your system and can be used to filter order lookup results. Max length of 128 characters.
Symbol representing the desired currency
Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.
Stripe publishable key. Use for tokenizing payment methods.
Payment intent client secret. Use for payment intent based payment capture and external captures
Payment Transactions associated to the bags on this Cart
Boolean indicating if the cart/order will be payed using a payment intent.
The payment method request for a cart. If the token is provided no card data is required.
Payment Token generated on a specific payment provider. When a token is provided, payment_provider must also be specified in the request.
Unique identifier of the Customer in the payment provider that the payment method is associated to. When a customer_id is provided, payment_provider must also be specified in the request.
Trigger payment intent based capture
Payment provider that this payment method was created on, if any.
IP address of the device from which this Payment Method originates.
Type of the payment method being passed in.
Number on the credit or debit card.
CVC code on the credit or debit card.
Expiration month of the credit or debit card.
Expiration year of the credit or debit card.
Postal Code of the credit or debit card.
Submit cart immediately after applying the payment method. Cannot be combined with intent_based_checkout.
Map the order in Violet to an order record within your system.
Direct order submission allows channels to submit fully composed orders, including their own tax and shipping calculations, in a single request to the merchant through Violet. This feature overrides the platform’s built-in pricing engine, ensuring accuracy in the merchant’s system of record and customer communications.
Learn more about Direct Order Submission in this guide.
The following information is required to be included in the Order payload of this request:
- First Name
- Last Name
- Shipping Address
- Bag(s)
For a multi-merchant Order, multiple bags must be created in the Order payload. Each Bag must contain items from only one merchant and have its own shipping method.
Violet currently only supports accepting Single-use Stripe Tokens as a payment method in this endpoint.
Headers
Body
Order
The payment method request for a cart. If the token is provided no card data is required.
Response
The response is of type any.
Was this page helpful?