Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Create Order
Violet Order Entity
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.
Customer's first name.
Customer's last name.
Customer's valid email address.
ID of the Customer on the External Platform
The shipping or billing address of a user placing an order
Name on Address
City
State or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
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 or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
Address Type
Email Address
First line of the Address
Second line of the Address
When only one address is provided, should the one address be used for both the shipping and billing addresses.
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
Name on Address
City
State or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
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 or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
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.
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
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.
Body
Violet Order Entity
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 parent Order this error occurred in.
ID of the parent Bag this error occurred in.
ID of the entity that caused the error. See the entity_type property to determine which entity this ID is associated with.
Type of entity that caused the error. See the entity_id property to determine which entity of this type is related to the error.
ORDER, BAG, SKU Type of error, indicates which action was being taken when the error occurred.
EXTERNAL_CREATE_CART, EXTERNAL_ADD_ITEM, EXTERNAL_UPDATE_ITEM, EXTERNAL_REMOVE_ITEM, EXTERNAL_ADD_CUSTOMER, EXTERNAL_ADD_ADDRESSES, EXTERNAL_ADD_SHIPPING_ADDRESS, EXTERNAL_ADD_BILLING_ADDRESS, EXTERNAL_GET_SHIPPING_METHODS, EXTERNAL_SET_SHIPPING_METHOD, EXTERNAL_SET_PAYMENT_METHOD, EXTERNAL_PRICE_CART, EXTERNAL_SUBMIT_CART, INTERNAL_ADD_ITEM, EXTERNAL_DELETE_CART, EXTERNAL_CANCEL_ORDER, EXTERNAL_WRITE_ORDER, EXTERNAL_MARK_ORDER_AS_PAID, EXTERNAL_ADD_DISCOUNT_CODE, EXTERNAL_REMOVE_DISCOUNT_CODE, EXTERNAL_DELETE_ORDER, EXTERNAL_REFUND_ORDER A string message providing more details about the error.
255Date the error was first created in Violet.
The external commerce platform the error occurred in.
OTHER, SHOPIFY, MAGENTO, MAGENTO_ONE, WOOCOMMERCE, BIGCOMMERCE, LIGHTSPEED, ECWID, YAAS, SPREECOMMERCE, DEMANDWARE, VOLUSION, PRESTASHOP, THREEDCART, SYLIUS, WIX, SWELL, MIVA, WEBSPHERE, ORACLECC, SAPCC, SQUARESPACE, SHOPWARE, COMMERCETOOLS, MEDUSA, ABICART, SPRYKER, MYSTORE, CENTRA, XCART, VTEX, KIBO, SALEOR, VENDO, CHORD, DIGITALRIVER, SQUARE, AMAZON, BIGCARTEL, CUSTOM 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.
Customer's first name.
Customer's last name.
Customer's valid email address.
ID of the Customer on the External Platform
The shipping or billing address of a user placing an order
City
State or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Address Type
SHIPPING, BILLING First line of the Address
Name on Address
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
Email Address
Second line of the Address
The shipping or billing address of a user placing an order
City
State or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Address Type
SHIPPING, BILLING First line of the Address
Name on Address
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
Email Address
Second line of the Address
When only one address is provided, should the one address be used for both the shipping and billing addresses.
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.
ID of the parent order the Bag is a child of.
ID of the merchant the Bag is related to.
ID of the App responsible for the creation and submission of this Order.
ID of the Order on the external commerce platform. This value will be null until the Order submitted.
Overall status of the Bag.
IN_PROGRESS, SUBMITTED, ACCEPTED, COMPLETED, PARTIALLY_REFUNDED, REFUNDED, REJECTED, CANCELED, BACKORDERED Fulfillment status of the Bag.
PROCESSING, SHIPPED, PARTIALLY_SHIPPED, DELIVERED, COULD_NOT_DELIVER, RETURNED Financial status of the Bag.
UNPAID, AUTHORIZED, PENDING, PAID, PARTIALLY_PAID, REFUNDED, PARTIALLY_REFUNDED, VOIDED Dispute status of the Bag.
UNDISPUTED, IN_DISPUTE, DISPUTE_WON, DISPUTE_LOST Sku's (line items) that have been added to the Bag.
Unique ID of the Sku in relation to the order.
ID of the parent Offer that this Sku is a child of.
ID of the Merchant this Sku belongs to.
ID of the App responsible for the creation and submission of this Order.
ID of the parent product the offer is a child off.
ID of the referenced Sku from the Violet catalog.
ID of the SKU on the external commerce platform.
Name of the Sku, as provided by the merchant.
Name of the brand selling this Sku.
URL of the thumbnail image. Useful for order overview displays.
Quantity of the Sku being purchased. Quantities over 1000 will default to 1000.
x < 1000Price of the individual SKU, in cents.
Weight of Sku.
Height of Sku.
Width of Sku.
Length of Sku.
Is the product still available for purchase. If a Sku becomes unavailable it likely means that the product became out of stock after it was added to the cart. Unavailable Sku's cannot be purchased.
Current status of the Sku.
IN_PROGRESS, PROCESSING, SHIPPED, PARTIALLY_SHIPPED, DELIVERED, COULD_NOT_DELIVER, RETURNED, CANCELED, REFUNDED, ERROR, PARTIALLY_RETURNED, PARTIALLY_REFUNDED Product type that describes the Sku.
PHYSICAL, DIGITAL, VIRTUAL, BUNDLED Is the Sku custom. Is true when the price has been overridden.
Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.
The quantity of this item that has been fulfilled by the merchant.
Rates that apply specifically to this Sku such as taxes, fees, or duties.
ID of the Order SKU the Rate belongs to
Total Tax amount on Bag. In Cents
Rate
Rate Type
TAX, SHIPPING, FEE, DUTY Rate Name
Price of the Sku multiplied by the quantity, in Cents
Shipping Methods belonging to an Order
Total cost of the Shipping Method. In Cents
ID of the referenced Shipping Method
ID of the Bag the Shipping Method applies to
ID of the merchant the bag belongs to
Type of Shipping Method
CALCULATED, FLAT_RATE_PRICE, FLAT_RATE_WEIGHT OTHER, UPS, USPS, FEDEX, DHL, ONTRAC, ROYAL_MAIL, SENDLE, POSTNORD Shipping Method Label
Is the shipping method custom. True when the price has been overridden.
Minimum Subtotal. In Cents. Only applies to Flat Rate by Price
Maximum Subtotal. In Cents. Only applies to Flat Rate by Price
Minimum Weight. In Cents. Only applies to Flat Rate by Weight
Maximum Weight. In Cents. Only applies to Flat Rate by Weight
ID(s) on external ecommerce platform
Carrier Tracking Number
Tax rates applied to the Bag.
ID of the Order the Tax belongs to
ID of the Merchant the Bag belongs to
SKUs covered by the Tax
State abbreviation
Postal/Zip Code
Tax Rate
Total Tax amount on Bag. In Cents
Description of the Tax
255The price of the Bag in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.
The sum of all shipping methods applied to the Bag in the base currency. In Cents
The sum of all the taxes applied to the Bag in the base currency. In Cents
The total discounts applied to the price of the Bag in the base currency. In Cents
The sum of all item prices, discounts, shipping, and taxes applied to the Bag in the base currency. In Cents
Are taxes included in the cart subtotal. When true the taxes will not be summed separately.
If the Bag is attached to an external cart in the commerce platform.
The rate used to calculate the apps commission rate for the Bag.
Date the Bag was created in Violet.
Date the Bag was last modified in Violet.
Date the Bag was last checked for updates. This is a part of Order Parity and is used to discover missed or unsent webhooks from the external commerce platforms.
Date when the Bag can no longer be refunded.
Base currency of the Bag.
Currency of the equivalent cart on external commerce platform.
Exchange rate of currency and external currency, if different, at the time the Bag was last priced.
The type of Channel that originated this Bag.
APP, MARKETPLACE, FACEBOOK, INSTAGRAM, WALMART, GOOGLE, TIKTOK, SNAPCHAT, PINTEREST Optional ID of the Order in the channels system. Automatically obtained through the app_order_id applied to the Order.
The commerce platform used by this merchant.
OTHER, SHOPIFY, MAGENTO, MAGENTO_ONE, WOOCOMMERCE, BIGCOMMERCE, LIGHTSPEED, ECWID, YAAS, SPREECOMMERCE, DEMANDWARE, VOLUSION, PRESTASHOP, THREEDCART, SYLIUS, WIX, SWELL, MIVA, WEBSPHERE, ORACLECC, SAPCC, SQUARESPACE, SHOPWARE, COMMERCETOOLS, MEDUSA, ABICART, SPRYKER, MYSTORE, CENTRA, XCART, VTEX, KIBO, SALEOR, VENDO, CHORD, DIGITALRIVER, SQUARE, AMAZON, BIGCARTEL, CUSTOM A list of fulfillments, if any, that have been applied to this Bag.
ID of the bag the fulfillment belongs to.
ID of the fulfillment on the external commerce platform.
Carrier responsible for the fulfillment. Will be OTHER if raw carrier is not recognized.
OTHER, UPS, USPS, FEDEX, DHL, ONTRAC, ROYAL_MAIL, SENDLE, POSTNORD Raw name of carrier from the external commerce platform.
Status of the bag fullfillment.
PENDING, PROCESSING, SUCCESS, CANCELED, ERROR, FAILURE, NONE_PROVIDED Status provided by the carrier.
PENDING, LABEL_PURCHASED, LABEL_PRINTED, CONFIRMED, READY_FOR_PICKUP, IN_TRANSIT, OUT_FOR_DELIVERY, ATTEMPTED_DELIVERY, DELIVERED, FAILURE, NONE_PROVIDED Tracking number provided by the carrier.
Tracking URL provided by the carrier.
SKUs fulfilled by this fulfillment.
A list of discounts, if any, that have been applied to this Bag.
ID of the Bag this discount belong to
Status of discount
PENDING, APPLIED, INVALID, NOT_SUPPORTED, ERROR, EXPIRED Type of discount
CODE Value type of discount
AMOUNT, PERCENTAGE Target type of the discount
ORDER, SKU, SHIPPING Code of discount
External ID of discount
Amount of discount
Percentage of discount
Total amount of discount applied to bag
Date of creation
Date of last bag discount update
Customer email address, possibly necessary for once-per-customer discounts.
Is this Bag going to be placed through wallet-based checkout.
Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.
IN_PROGRESS, SUBMITTED, ACCEPTED, COMPLETED, PARTIALLY_REFUNDED, REFUNDED, REJECTED, CANCELED, BACKORDERED Name of the merchant the Bag is related to.
The shipping or billing address of a user placing an order
City
State or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Address Type
SHIPPING, BILLING First line of the Address
Name on Address
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
Email Address
Second line of the Address
The shipping or billing address of a user placing an order
City
State or province abbreviated code.
Country ISO2 Code
Postal/Zip Code
Address Type
SHIPPING, BILLING First line of the Address
Name on Address
Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.
Email Address
Second line of the Address
Payment Method belonging to an Order
ID of the referenced Payment Method
Brand of Card
Last Four Numbers on Card
Card Expiration Month
Card Expiration Year
Name as it appears on Card
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.
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
Unique identifier for the object
Identifier of the Order entity that this payment transaction is associated with
Payment Provider that this transaction is executed against. This is the provider that handles payment processing for this transaction.
Identifier of the payment transaction in the underlying payment provider system.
Identifier of the payment method associated with this payment transaction in Violet.
Identifier of the payment method associated with this payment transaction in the underlying payment provider system.
Client secret for the payment intent associated to this payment transaction
Amount of this payment in the fractional currency unit of this transaction (e.g. cents). This is the amount charged to the shopper.
Currency that the amount of this payment transaction is reflected in. This is the currency that the payment provider uses to charge the shopper payment method.
Underlying status of the payment capture in the payment provider system and should be used to determine what action to take next against this payment transaction.
PROCESSING, CAPTURED, CANCELLED, FAILED, BYPASSED, REQUIRES_ACTION, REQUIRES_PAYMENT_METHOD, REQUIRES_AUTHORIZATION, AUTHORIZED, REFUNDED, PARTIALLY_REFUNDED Underlying status of the payment in the payment provider system and should be used to determine what action to take next against this payment transaction.
AUTOMATIC, CUSTOM, EXTERNAL Status of the transfer of distributions associated with this payment transaction.
SENT, REVERSED, PARTIALLY_REVERSED, PENDING, FAILED, BYPASSED Underlying status of the payment in the payment provider system and should be used to determine what action to take next against this payment transaction.
AUTOMATIC, CUSTOM, EXTERNAL Metadata from the payment provider associated to this payment transaction
Metadata from the payment provider associated to this payment transaction
Identifiers of the Bags in Violet that are associated with this payment transaction. The amount of this payment transaction is directly computed from the total amounts on the related bags.
Identifiers of the Refunds in Violet that are associated with this payment transaction. Refund amounts are not reflected in the amount on this payment transaction.
List of errors associated to this payment transaction during processing.. This value will only be populated if there are errors during processing
Unique error code corresponding to this error.
Error message describing the issue in the underlying system.
Identifier of the PaymentTransaction entity that this error is associated with
Time at which the object was created. In ISO-8601 format.
Time at which the object was last modified. In ISO-8601 format.
PROCESSING, CAPTURED, CANCELLED, FAILED, BYPASSED, REQUIRES_ACTION, REQUIRES_PAYMENT_METHOD, REQUIRES_AUTHORIZATION, AUTHORIZED, REFUNDED, PARTIALLY_REFUNDED IN_PROGRESS, PROCESSING, COMPLETED, CANCELED, PARTIALLY_REFUNDED, REFUNDED, REQUIRES_ACTION 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.
SINGLE_USE_CARD_TOKEN, MULTI_USE_CARD_TOKEN, BANK_TOKEN, PAYMENT_INTENT, VIOLET_PAYMENT_METHOD_ID 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.
Response
The response is of type any.
Was this page helpful?