Add Discount to Cart

Add discounts to a cart given its cart_id.

Discounts are added at a per merchant level and each merchant is required to have created this discount code in their E-Commerce platform prior to being applied through Violet. You can read more about discount codes here.

Add Discount 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

application/json

Details of the discount being applied to a cart.

codestring · min: 1 · max: 255Required

Discount code being applied.

merchant_idinteger · int32Required

ID of the Merchant the discount belongs to.

emailstring · max: 255Optional

Optional customer email address, possibly necessary for once-per-customer discounts.

Responses

200

success

application/json

400

bad request

application/json

404

not found

application/json

post

/checkout/cart/{cart_id}/discounts

HTTPcURLJavaScriptPython

POST /v1/checkout/cart/{cart_id}/discounts 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: 44

{
  "code": "discount-code",
  "merchant_id": 10000
}

Add Discount CodeAdd Discount Code with Email

{
  "id": 10000,
  "token": "fz8x7gksdjsy2p9fdlonw7k9svwjso4b",
  "user_id": 10000,
  "app_id": 10000,
  "developer_id": 10000,
  "customer": {
    "user_id": 10000,
    "first_name": "Super",
    "last_name": "Mario",
    "email": "[email protected]",
    "name": "Super Mario"
  },
  "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
        }
      ],
      "discounts": [
        {
          "id": 33333,
          "bag_id": 11111,
          "status": "APPLIED",
          "type": "CODE",
          "value_type": "PERCENTAGE",
          "target_type": "ORDER",
          "code": "discount-code",
          "percentage": 10,
          "amount_total": 1999,
          "date_created": "2017-06-15T01:01:01+0000",
          "date_last_modified": "2017-06-15T01:01:01+0000"
        }
      ],
      "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": [],
      "wallet_based_checkout": false,
      "bag_id": 22222,
      "bag_status": "IN_PROGRESS",
      "merchant_name": "Legacy Games"
    }
  ],
  "shipping_address": {
    "name": "Super Mario",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "postal_code": "98121",
    "phone": "1234567890",
    "type": "SHIPPING",
    "address_1": "2815 Elliott Ave, Unit 100",
    "first_name": "Super",
    "last_name": "Mario"
  },
  "billing_address": {
    "name": "Super Mario",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "postal_code": "98121",
    "phone": "1234567890",
    "type": "BILLING",
    "address_1": "2815 Elliott Ave, Unit 100",
    "first_name": "Super",
    "last_name": "Mario"
  },
  "payment_method": null,
  "sub_total": 19998,
  "shipping_total": 0,
  "tax_total": 0,
  "discount_total": 1999,
  "total": 17999,
  "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
}