POST
/
checkout
/
cart
/
{cart_id}
/
shipping_address
Header
Path
Query
Body
curl --request POST \
  --url https://sandbox-api.violet.io/v1/checkout/cart/{cart_id}/shipping_address \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "city": "<string>",
  "state": "<string>",
  "country": "<string>",
  "postal_code": "<string>",
  "phone": "<string>",
  "type": "shipping",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "address_1": "<string>",
  "address_2": "<string>"
}'
{
  "id": 123,
  "token": "<string>",
  "user_id": 123,
  "app_id": 123,
  "developer_id": 123,
  "customer": {
    "user_id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "external_id": "<string>",
    "shipping_address": {
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "postal_code": "<string>",
      "type": "shipping",
      "address_1": "<string>"
    },
    "billing_address": {
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "postal_code": "<string>",
      "type": "shipping",
      "address_1": "<string>"
    },
    "same_address": true,
    "name": "<string>"
  },
  "bags": [
    {
      "id": 123,
      "order_id": 123,
      "merchant_id": 123,
      "app_id": 123,
      "external_id": "<string>",
      "status": "IN_PROGRESS",
      "fulfillment_status": "PROCESSING",
      "financial_status": "UNPAID",
      "skus": [],
      "shipping_method": {
        "price": 123,
        "shipping_method_id": "<string>",
        "bag_id": 123,
        "merchant_id": 123
      },
      "taxes": [],
      "sub_total": 123,
      "shipping_total": 123,
      "tax_total": 123,
      "discount_total": 123,
      "total": 123,
      "taxes_included": true,
      "transactions": [],
      "external_checkout": true,
      "commission_rate": 123,
      "date_created": "2023-11-07T05:31:56Z",
      "remorse_period_ends": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "external_currency": "<string>",
      "currency_exchange_rate": 123,
      "channel": "APP",
      "app_order_id": "<string>",
      "platform": "OTHER",
      "fulfillments": [],
      "discounts": [],
      "wallet_based_checkout": true,
      "app_name": "<string>",
      "bag_id": 123,
      "bag_status": "IN_PROGRESS",
      "merchant_name": "<string>"
    }
  ],
  "shipping_address": {
    "name": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "phone": "<string>",
    "type": "shipping",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "address_1": "<string>",
    "address_2": "<string>"
  },
  "billing_address": {
    "name": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "phone": "<string>",
    "type": "shipping",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "address_1": "<string>",
    "address_2": "<string>"
  },
  "payment_method": {
    "brand": "<string>",
    "last_four": "<string>",
    "exp_month": 123,
    "exp_year": 123,
    "cardholder_name": "<string>",
    "payment_method_id": 123,
    "default": true
  },
  "sub_total": 123,
  "shipping_total": 123,
  "tax_total": 123,
  "discount_total": 123,
  "total": 123,
  "app_customer_id": "<string>",
  "app_order_id": "<string>",
  "status": "in_progress",
  "is_guest": true,
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z",
  "priced": true,
  "wallet_based_checkout": true,
  "currency": "<string>",
  "referral_id": "<string>",
  "errors": [
    {
      "id": 123,
      "order_id": 123,
      "bag_id": 123,
      "entity_id": "<string>",
      "type": "EXTERNAL_CREATE_CART",
      "message": "<string>",
      "date_created": "2023-11-07T05:31:56Z",
      "platform": "OTHER"
    }
  ],
  "currency_symbol": "<string>",
  "app_name": "<string>",
  "stripe_key": "<string>",
  "payment_intent_client_secret": "<string>",
  "guest": true,
  "order_status": "IN_PROGRESS",
  "intent_based_checkout": true,
  "order_id": 123
}

Note: For more information on this endpoint go to Set Shipping Methods

Once we have all the available shipping methods for the bags within the cart, you can select and apply them to the cart.

Note: Your bag_id and cart_id will be different from the example you have been following so far. Please update the calls with your information.

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

Name on Address

city
string
required

City

state
string
required

State Abbreviation

country
string
required

Country ISO2 Code

postal_code
string
required

Postal/Zip Code

phone
string

Phone Number

type
enum<string>
required

Address Type

Available options:
shipping,
billing
email
string

Email Address

first_name
string
last_name
string
address_1
string
required

First line of the Address

address_2
string

Second line of the Address

Response

200 - application/json
id
integer
token
string
user_id
integer

ID of the User placing the order

app_id
integer

ID of the App creating the order

developer_id
integer

ID of the Developer who placed

customer
object

The Customer Placing the Order

bags
object[]

Bags in the Order

shipping_address
object

The shipping or billing address of a user placing an order

billing_address
object

The shipping or billing address of a user placing an order

payment_method
object

Payment Method belonging to an Order

sub_total
integer

Subtotal of the Order

shipping_total
integer

Shipping Total of the Order

tax_total
integer

Tax Total of the Order

discount_total
integer

Discount Total of the Order

total
integer

Total of the Order

app_customer_id
string

App Customer ID

app_order_id
string

App Order ID

status
enum<string>
required

Status of the Order

Available options:
in_progress,
processing,
completed,
canceled,
partially_refunded,
refunded,
requires_action
is_guest
boolean

Order is Guest

date_created
string

Date of order creation

date_last_modified
string

Date of last order update

priced
boolean

Is the cart priced

wallet_based_checkout
boolean

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

currency
string

Base currency of cart

referral_id
string

Optional value used to represent an identifier in your system.

errors
object[]

Errors on the Order

currency_symbol
string

Symbol representing the desired currency

app_name
string

Name of app that originated the order.

stripe_key
string

Stripe publishable key. Use for tokenizing payment methods.

payment_intent_client_secret
string

Payment intent client secret

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

Was this page helpful?

Get Available Shipping MethodsApply Payment Info