POST
/
checkout
/
cart
/
{cart_id}
/
skus
curl --request POST \
  --url https://sandbox-api.violet.io/v1/checkout/cart/{cart_id}/skus \
  --header 'Content-Type: application/json' \
  --data '{
  "sku_id": 99999,
  "quantity": 2
}'
{
  "id": 10000,
  "token": "fz8x7gksdjsy2p9fdlonw7k9svwjso4b",
  "user_id": 10000,
  "app_id": 10000,
  "developer_id": 10000,
  "customer": null,
  "bags": [
    {
      "id": 11111,
      "order_id": 22222,
      "merchant_id": 10000,
      "app_id": 10000,
      "status": "IN_PROGRESS",
      "fulfillment_status": "PROCESSING",
      "financial_status": "UNPAID",
      "skus": [
        {
          "id": 10000,
          "merchant_id": 10000,
          "app_id": 10000,
          "sku_id": 99999,
          "external_id": "1234567890",
          "name": "Nintendo Entertainment System",
          "brand": "Nintendo",
          "thumbnail": "https://res.cloudinary.com/violet/image/upload/c_thumb,w_200,g_face/v1729220594/product_media/2taesr1g7sciu8agrrtgaafi2dnzzmsv.jpg",
          "quantity": 2,
          "price": 9999,
          "weight": 1,
          "available": true,
          "status": "PROCESSING",
          "product_type": "PHYSICAL",
          "custom": false,
          "line_price": 19998
        }
      ],
      "shipping_method": null,
      "taxes": null,
      "sub_total": 19998,
      "shipping_total": 0,
      "tax_total": 0,
      "discount_total": 0,
      "total": 19998,
      "taxes_included": false,
      "transactions": null,
      "external_checkout": true,
      "commission_rate": 10,
      "date_created": "2017-06-15T01:01:01+0000",
      "date_last_modified": "2017-06-15T01:01:01+0000",
      "remorse_period_ends": "2017-06-15T01:01:01+0000",
      "currency": "USD",
      "external_currency": "USD",
      "channel": "APP",
      "platform": "SHOPIFY",
      "fulfillments": [],
      "discounts": [],
      "wallet_based_checkout": false,
      "bag_id": 22222,
      "bag_status": "IN_PROGRESS",
      "merchant_name": "Legacy Games"
    }
  ],
  "shipping_address": null,
  "billing_address": null,
  "payment_method": null,
  "sub_total": 19998,
  "shipping_total": 0,
  "tax_total": 0,
  "discount_total": 0,
  "total": 19998,
  "app_order_id": "00100100",
  "status": "IN_PROGRESS",
  "is_guest": true,
  "date_created": "2017-06-15T01:01:01+0000",
  "date_last_modified": "2017-06-15T01:01:01+0000",
  "priced": false,
  "wallet_based_checkout": false,
  "currency": "USD",
  "channel": "APP",
  "currency_symbol": "$",
  "stripe_key": "pk_test_UHg8oLvg4rrDCbvtqfwTE8qd",
  "payment_intent_client_secret": "pi_vw8krrsvposl347c5l7x1nt5_secret_vbcw5t2bze37iptq430tmx7s",
  "payment_transactions": null,
  "intent_based_checkout": true,
  "guest": true,
  "order_id": 11111
}

Add a SKU to a cart given a cart_id and a sku_id.

Headers

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

Path Parameters

cart_id
integer
required

Query Parameters

price_cart
boolean
default: false

Body

application/json

SKUs belonging to an Order

sku_id
integer
required

ID of the referenced Sku from the Violet catalog.

id
integer

Unique ID of the Sku in relation to the order.

offer_id
integer

ID of the parent Offer that this Sku is a child of.

merchant_id
integer

ID of the Merchant this Sku belongs to.

app_id
integer

ID of the App responsible for the creation and submission of this Order.

product_id
string
deprecated

ID of the parent product the offer is a child off.

external_id
string

ID of the SKU on the external commerce platform.

name
string

Name of the Sku, as provided by the merchant.

brand
string

Name of the brand selling this Sku.

thumbnail
string

URL of the thumbnail image. Useful for order overview displays.

quantity
integer

Quantity of the Sku being purchased. Quantities over 1000 will default to 1000.

Required range: x < 1000
price
integer

Price of the individual SKU, in cents.

weight
number | null

Weight of Sku.

height
number | null

Height of Sku.

width
number | null

Width of Sku.

length
number | null

Length of Sku.

available
boolean

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.

status
enum<string>

Current status of the Sku.

Available options:
IN_PROGRESS,
PROCESSING,
SHIPPED,
PARTIALLY_SHIPPED,
DELIVERED,
COULD_NOT_DELIVER,
RETURNED,
CANCELED,
REFUNDED,
ERROR,
PARTIALLY_RETURNED,
PARTIALLY_REFUNDED
product_type
enum<string>

Product type that describes the Sku.

Available options:
PHYSICAL,
DIGITAL,
VIRTUAL,
BUNDLED
custom
boolean

Is the Sku custom. Is true when the price has been overridden.

custom_properties
array | null

Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.

quantity_fulfilled
integer

The quantity of this item that has been fulfilled by the merchant.

line_price
integer

Price of the Sku multiplied by the quantity, in Cents

Response

200 - application/json

Violet Order Entity

id
integer

ID of the Violet cart or order.

token
string
deprecated

An alternative UUID that can be used as an ID to reference the cart or order.

errors
array | null

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.

user_id
integer
deprecated

ID of the User placing the order

app_id
integer

ID of the App responsible for the creation and submission of this Order.

developer_id
integer

ID of the Developer responsible for the creation and submission of this Order.

customer
object | null

Details of the customer placing the order.

bags
object[]

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.

shipping_address
object | null

The shipping or billing address of a user placing an order

billing_address
object | null

The shipping or billing address of a user placing an order

payment_method
object | null

Payment Method belonging to an Order

sub_total
integer
default: 0

The price of the Order in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.

shipping_total
integer
default: 0

The sum of all shipping methods applied to the Order in the base currency. In Cents.

tax_total
integer
default: 0

The sum of all the taxes applied to the Order in the base currency. In Cents.

discount_total
integer
default: 0

The total discounts applied to the price of the Order in the base currency. In Cents.

total
integer
default: 0

The sum of all item prices, discounts, shipping, and taxes applied to the Order in the base currency. In Cents.

app_customer_id
string | null

App Customer ID. This should be used to map the order to the ID of the customer in your application.

app_order_id
string | null

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
enum<string>

Status of the Order

Available options:
IN_PROGRESS,
PROCESSING,
COMPLETED,
CANCELED,
PARTIALLY_REFUNDED,
REFUNDED,
REQUIRES_ACTION
is_guest
boolean
default: true

Order is Guest

date_created
string

Date of order creation

date_last_modified
string

Date of last order update

priced
boolean
default: false

Is the cart priced

wallet_based_checkout
boolean
default: false

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

currency
string
default: USD

Base currency of cart

referral_id
string | null

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.

currency_symbol
string

Symbol representing the currency the Order operates in.

app_name
string

Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.

stripe_key
string

Stripe publishable key. Use for tokenizing payment methods.

payment_intent_client_secret
string

Payment intent client secret. Use for payment intent based payment capture and external captures

payment_transactions
object[]

Payment Transactions associated to the bags on this Cart

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

Boolean indicating if the cart/order will be payed using a payment intent.

Was this page helpful?

Delete CartUpdate SKU in Cart