1min

Create Cart

POST
Creates a new empty cart.

By setting the 'apply_current_user' flag to true the user associated with the current access token will be applied to the cart. If the user has an existing shipping address and/or billing address saved to their account these will automatically be applied to the cart. Only applies to oAuthed customer transactions.

By setting the 'default_payment_method' flag to true the default payment method, if one exists, of the user associated with the current token will be applied to the cart. Only applies to oAuthed customer transactions.

Use the optional 'app_order_id' parameter to map the newly created cart to an ID in your systems.
QUERY PARAMETERS
app_order_idstring
base_currencystring
referral_idstring
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
BODY PARAMETERS
body
CartInitializationRequest
Optional data to initialize the cart with on creation.
base_currencystring
Base currency of cart
skus
OrderSku[]
Optional collection of SKUs
referral_idstring
Custom ID for Channel Tracking
RESPONSES
200
successful operation
Order
Order
idinteger<int64>
tokenstring
seller_idinteger<int64>
ID of the Seller
user_idinteger<int64>
ID of the User placing the order
app_idinteger<int64>
ID of the App creating the order
customer
OrderCustomer
Customer placing the order
bags
Bag[]
Bags in the Order
shipping_address
OrderAddress
Shipping Address of the Order
billing_address
OrderAddress
Billing Address of the Order
payment_method
OrderPaymentMethod
Payment Method of the Order
sub_totalinteger<int32>
Subtotal of the Order
shipping_totalinteger<int32>
Shipping Total of the Order
tax_totalinteger<int32>
Tax Total of the Order
totalinteger<int32>
Total of the Order
app_customer_idstring
App Customer ID
app_order_idstring
App Order ID
statusstring<in_progress | processing | completed | canceled | partially_refunded | refunded>
Status of the Order
date_createdstring<date-time>
Date of order creation
date_last_modifiedstring<date-time>
Date of last order update
guestboolean
Is the customer a guest or an authed user.
referral_idstring
Optional value used to represent an identifier in your system. Max length of 128 characters.
Updated 21 Apr 2022
Did this page help you?
Yes
No