Set Billing Address

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

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

Set Billing Address

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

The shipping or billing address of a user placing an order

namestringOptional

Name on Address

citystringRequired

City

statestringRequired

State or province abbreviated code.

countrystringRequired

Country ISO2 Code

postal_codestringRequired

Postal or Zip code to be applied to the address. This value is required for all countries that have postal codes. For countries that do not have postal codes, this value is optional.

phonestringOptional

Phone number related to the address. Note: Some external commerce platforms require this value. For these platforms Violet will use a fake number if no value is provided to ensure that the order succeeds.

typestring · enumRequired

Address Type

Possible values:

emailstringOptional

Email Address

address_1stringRequired

First line of the Address

address_2stringOptional

Second line of the address

first_namestringOptional

last_namestringOptional

Responses

200

success

application/json

400

bad request

application/json

404

not found

application/json

post

HTTPcURLJavaScriptPython

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

{
  "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": null,
  "billing_address": {
    "name": "Super Mario",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "postal_code": "98121",
    "phone": "1234567890",
    "type": "BILLING",
    "address_1": "2815 Elliott Ave",
    "address_2": "Unit 100",
    "first_name": "Super",
    "last_name": "Mario"
  },
  "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
}