POST
/
checkout
/
cart
/
{cart_id}
/
shipping_address
curl --request POST \
  --url https://sandbox-api.violet.io/v1/checkout/cart/{cart_id}/shipping_address \
  --header 'Content-Type: application/json' \
  --header 'X-Violet-App-Id: <x-violet-app-id>' \
  --header 'X-Violet-App-Secret: <x-violet-app-secret>' \
  --header 'X-Violet-Token: <x-violet-token>' \
  --data '{
  "city": "Seattle",
  "state": "WA",
  "country": "US",
  "postal_code": "98121",
  "phone": "1234567890",
  "address_1": "2815 Elliott Ave",
  "address_2": "Unit 100"
}'
{
  "id": 10000,
  "token": "fz8x7gksdjsy2p9fdlonw7k9svwjso4b",
  "user_id": 10000,
  "app_id": 10000,
  "developer_id": 10000,
  "customer": null,
  "bags": [],
  "shipping_address": {
    "name": "Super Mario",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "postal_code": "98121",
    "phone": "1234567890",
    "type": "SHIPPING",
    "address_1": "2815 Elliott Ave",
    "address_2": "Unit 100",
    "first_name": "Super",
    "last_name": "Mario"
  },
  "billing_address": null,
  "payment_method": null,
  "sub_total": 0,
  "shipping_total": 0,
  "tax_total": 0,
  "discount_total": 0,
  "total": 0,
  "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
}

Apply a Shipping Address to a cart given its cart_id. The Shipping Address is of type OrderAddress.

Some E-commerce platforms require Customer Phone numbers as a part of the Shipping Address to contact recipients. You can attach a phone number to the OrderAddress.

While rare, this request may fail if the provided address is included in the Blocked Addresses list.

Headers

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

Path Parameters

​
cart_id
integer
required

Query Parameters

​
price_cart
boolean
default:false

Body

application/json

The shipping or billing address of a user placing an order

Response

200
application/json

success

Violet Order Entity