Create Cart
/v1/checkout/cart
Note: For more details on this endpoint please refer to the Create Cart API Reference
Cart creation begins the checkout process. Products can be added to the cart at creation with a JSON Body listing 1 or more sku_id & quantity pairs.
Note: It is not required that you add a SKU to create a cart, since it is possible for your customers cart to be empty, however, in this example, we will purchase a product with the SKU 10064 (which we noted down from the previous section)
Params
HEADER PARAMETERS
Your app secret
Your app ID
The token provided on login, or upon token refresh
BODY PARAMETERS
Base currency for the order
Object array including, sku_id and quantity of each sku
curl -s --request POST \
--url 'sandbox-api.violet.io/v1/checkout/cart' \
--header 'X-Violet-Token: ' \
--header 'X-Violet-App-Secret: ' \
--header 'X-Violet-App-Id: ' \
--header 'Content-type: application/json' \
--data '{
"base_currency": "",
"skus": [
{
"sku_id": 10064 ,
"quantity": 1
}
]
}'
{
"id": 20956,
"token": "c8f17e9e6fec4268bc9188f039ec68ad",
"user_id": 10397,
"app_id": 10382,
"developer_id": 10292,
"bags": [
{
"id": 20440,
"order_id": 20956,
"merchant_id": 10000,
"app_id": 10382,
"status": "IN_PROGRESS",
"fulfillment_status": "PROCESSING",
"financial_status": "UNPAID",
"skus": [
{
"id": 24987,
"merchant_id": 10000,
"app_id": 10382,
"product_id": "0ff55c5cda7447118d6ae1c8395f8f11",
"sku_id": 10064,
"external_id": "13884047425654",
"name": "GoPro - Karma Quadcopter with HERO6 Black - White - White",
"brand": "GoPro",
"thumbnail": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/6029300_ra.jpg",
"quantity": 1,
"price": 84999,
"weight": 13.45,
"available": true,
"status": "IN_PROGRESS",
"line_price": 84999
}
],
"taxes": [],
"sub_total": 84999,
"transactions": [],
"external_checkout": true,
"commission_rate": 15.0,
"date_created": "2022-05-11T16:17:16+0000",
"remorse_period_ends": "2022-06-10T16:17:16+0000",
"currency": "USD",
"external_currency": "USD",
"channel": "APP",
"platform": "SHOPIFY",
"fulfillments": [],
"merchant_name": "Violet-Besties"
}
],
"sub_total": 84999,
"status": "IN_PROGRESS",
"date_created": "2022-05-11T16:17:16+0000",
"date_last_modified": "2022-05-11T16:17:16+0000",
"priced": false,
"currency": "USD",
"errors": [],
"channel": "APP",
"currency_symbol": "$",
"stripe_key": "pk_test_UHg8oLvg4rrDCbvtqfwTE8qd",
"guest": true
}
Headers
Query Parameters
APP
, MARKETPLACE
, FACEBOOK
, INSTAGRAM
, WALMART
, GOOGLE
, TIKTOK
, SNAPCHAT
, PINTEREST
Body
Map the order in Violet to an order record within your system
Base currency of cart
The Customer Placing the Order
Optional collection of Discounts
Associate the order with a user or affiliate in your system
Optional collection of SKUs
Boolean denoting whether or not this order will be placed through a wallet based payment mechanism such as apple pay
Response
App Customer ID
ID of the App creating the order
Name of app that originated the order.
App Order ID
Bags in the Order
The shipping or billing address of a user placing an order
Base currency of cart
Symbol representing the desired currency
The Customer Placing the Order
Date of order creation
Date of last order update
ID of the Developer who placed
Discount Total of the Order
Errors on the Order
Order is Guest
IN_PROGRESS
, PROCESSING
, COMPLETED
, CANCELED
, PARTIALLY_REFUNDED
, REFUNDED
, REQUIRES_ACTION
Payment intent client secret
Payment Method belonging to an Order
Is the cart priced
Optional value used to represent an identifier in your system.
The shipping or billing address of a user placing an order
Shipping Total of the Order
Status of the Order
in_progress
, processing
, completed
, canceled
, partially_refunded
, refunded
, requires_action
Stripe publishable key. Use for tokenizing payment methods.
Subtotal of the Order
Tax Total of the Order
Total of the Order
ID of the User placing the order
Is this cart going to be placed through wallet-based checkout
curl -s --request POST \
--url 'sandbox-api.violet.io/v1/checkout/cart' \
--header 'X-Violet-Token: ' \
--header 'X-Violet-App-Secret: ' \
--header 'X-Violet-App-Id: ' \
--header 'Content-type: application/json' \
--data '{
"base_currency": "",
"skus": [
{
"sku_id": 10064 ,
"quantity": 1
}
]
}'
{
"id": 20956,
"token": "c8f17e9e6fec4268bc9188f039ec68ad",
"user_id": 10397,
"app_id": 10382,
"developer_id": 10292,
"bags": [
{
"id": 20440,
"order_id": 20956,
"merchant_id": 10000,
"app_id": 10382,
"status": "IN_PROGRESS",
"fulfillment_status": "PROCESSING",
"financial_status": "UNPAID",
"skus": [
{
"id": 24987,
"merchant_id": 10000,
"app_id": 10382,
"product_id": "0ff55c5cda7447118d6ae1c8395f8f11",
"sku_id": 10064,
"external_id": "13884047425654",
"name": "GoPro - Karma Quadcopter with HERO6 Black - White - White",
"brand": "GoPro",
"thumbnail": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/6029300_ra.jpg",
"quantity": 1,
"price": 84999,
"weight": 13.45,
"available": true,
"status": "IN_PROGRESS",
"line_price": 84999
}
],
"taxes": [],
"sub_total": 84999,
"transactions": [],
"external_checkout": true,
"commission_rate": 15.0,
"date_created": "2022-05-11T16:17:16+0000",
"remorse_period_ends": "2022-06-10T16:17:16+0000",
"currency": "USD",
"external_currency": "USD",
"channel": "APP",
"platform": "SHOPIFY",
"fulfillments": [],
"merchant_name": "Violet-Besties"
}
],
"sub_total": 84999,
"status": "IN_PROGRESS",
"date_created": "2022-05-11T16:17:16+0000",
"date_last_modified": "2022-05-11T16:17:16+0000",
"priced": false,
"currency": "USD",
"errors": [],
"channel": "APP",
"currency_symbol": "$",
"stripe_key": "pk_test_UHg8oLvg4rrDCbvtqfwTE8qd",
"guest": true
}