Add SKU to Cart

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

Add SKU to Cart

post
Path parameters
cart_idinteger · int64Required
Query parameters
price_cartbooleanOptionalDefault: false
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body

SKUs belonging to an Order

idinteger · int64Optional

Unique ID of the Sku in relation to the order.

offer_idinteger · int64Optional

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

merchant_idinteger · int32Optional

ID of the Merchant this Sku belongs to.

app_idinteger · int32Optional

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

product_idstringOptionalDeprecated

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

sku_idinteger · int64Required

ID of the referenced Sku from the Violet catalog.

external_idstringOptional

ID of the SKU on the external commerce platform.

namestringOptional

Name of the Sku, as provided by the merchant.

brandstringOptional

Name of the brand selling this Sku.

thumbnailstringOptional

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

quantityinteger · int32 · max: 1000Optional

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

priceinteger · int32Optional

Price of the individual SKU, in cents.

weightnumber · double | nullableOptional

Weight of Sku.

heightnumber · double | nullableOptional

Height of Sku.

widthnumber · double | nullableOptional

Width of Sku.

lengthnumber · double | nullableOptional

Length of Sku.

availablebooleanOptional

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.

statusstring · enumOptional

Current status of the Sku.

Possible values:
product_typestring · enumOptional

Product type that describes the Sku.

Possible values:
custombooleanOptional

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

quantity_fulfilledinteger · int32Optional

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

line_priceinteger · int32Optional

Price of the Sku multiplied by the quantity, in Cents

Responses
200
success
application/json
post
POST /v1/checkout/cart/{cart_id}/skus HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "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
}

Last updated

Was this helpful?