Get Order by ID
Retrieve the details for an Order given its order_id.
Headers
Path Parameters
Query Parameters
Response
Violet Order Entity
ID of the Violet cart or order.
An alternative UUID that can be used as an ID to reference the cart or 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 responsible for the creation and submission of this Order.
ID of the Developer responsible for the creation and submission of this Order.
Details of the customer placing the order.
One or more Bags that make up the Order. Each Bag will contain the Sku's, shipping methods, and totals unique to a merchant. Each merchant in an Order will have their own Bag.
The shipping or billing address of a user placing an order
The shipping or billing address of a user placing an order
Payment Method belonging to an Order
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
IN_PROGRESS, PROCESSING, COMPLETED, CANCELED, PARTIALLY_REFUNDED, REFUNDED, REQUIRES_ACTION 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 currency the Order operates in.
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
IN_PROGRESS, PROCESSING, COMPLETED, CANCELED, PARTIALLY_REFUNDED, REFUNDED, REQUIRES_ACTION Boolean indicating if the cart/order will be payed using a payment intent.
Was this page helpful?