POST

/v1/checkout/cart

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id

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

X-Violet-App-Secretrequired
String

Your app secret

X-Violet-App-Idrequired
String

Your app ID

X-Violet-App-Tokenrequired
String

The token provided on login, or upon token refresh

BODY PARAMETERS

base_currency
String

Base currency for the order

skus
Array

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

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Query Parameters

apply_current_user
Default: false
boolean
default_payment
Default: false
boolean
app_order_id
string
base_currency
string
referral_id
string
channel
enum<string>
Available options:
APP,
MARKETPLACE,
FACEBOOK,
INSTAGRAM,
WALMART,
GOOGLE,
TIKTOK,
SNAPCHAT,
PINTEREST
async
Default: true
boolean

Body

application/json
app_order_id
string

Map the order in Violet to an order record within your system

base_currency
string

Base currency of cart

customer
object

The Customer Placing the Order

discounts
object[]

Optional collection of Discounts

referral_id
string

Associate the order with a user or affiliate in your system

skus
object[]

Optional collection of SKUs

wallet_based_checkout
boolean

Boolean denoting whether or not this order will be placed through a wallet based payment mechanism such as apple pay

Response

200 - application/json
app_customer_id
string

App Customer ID

app_id
integer

ID of the App creating the order

app_name
string

Name of app that originated the order.

app_order_id
string

App Order ID

bags
object[]

Bags in the Order

billing_address
object

The shipping or billing address of a user placing an order

currency
string

Base currency of cart

currency_symbol
string

Symbol representing the desired currency

customer
object

The Customer Placing the Order

date_created
string

Date of order creation

date_last_modified
string

Date of last order update

developer_id
integer

ID of the Developer who placed

discount_total
integer

Discount Total of the Order

errors
object[]

Errors on the Order

guest
boolean
id
integer
intent_based_checkout
boolean
is_guest
boolean

Order is Guest

order_id
integer
order_status
enum<string>
Available options:
IN_PROGRESS,
PROCESSING,
COMPLETED,
CANCELED,
PARTIALLY_REFUNDED,
REFUNDED,
REQUIRES_ACTION
payment_intent_client_secret
string

Payment intent client secret

payment_method
object

Payment Method belonging to an Order

priced
boolean

Is the cart priced

referral_id
string

Optional value used to represent an identifier in your system.

shipping_address
object

The shipping or billing address of a user placing an order

shipping_total
integer

Shipping Total of the Order

statusrequired
enum<string>

Status of the Order

Available options:
in_progress,
processing,
completed,
canceled,
partially_refunded,
refunded,
requires_action
stripe_key
string

Stripe publishable key. Use for tokenizing payment methods.

sub_total
integer

Subtotal of the Order

tax_total
integer

Tax Total of the Order

token
string
total
integer

Total of the Order

user_id
integer

ID of the User placing the order

wallet_based_checkout
boolean

Is this cart going to be placed through wallet-based checkout

OverviewApply Guest Customer to Cart