POST

/v1/checkout/cart/{cart_id}/customer

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id

Note: For more details on this endpoint please refer to the API Reference

Once you have a cart with products in it you need to apply the customer information. For a brand new customer this would likely include Apply Guest Customer to Cart , Set Shipping Address , and Set Billing Address.

Though for the sake of ease in this Recipe we will simply address handling and use the same address for billing and shipping and pass this through the body of the request. For more details on what fields this API can take, refer to the documentation linked above. In this example, we have used the cart we created in the previous step. Your Cart Id will be different and need to be updated in the request below.

Using same_address: true we can set the shipping and billing address simultaneously.

  • Params

HEADER PARAMETERS

X-Violet-App-Token
String

Token

X-Violet-App-Secret
String

App Secret from Dashboard

X-Violet-App-Id
String

Your app ID

curl --location --request POST 'https://sandbox-api.violet.io/v1/checkout/cart/20956/customer' \
--header 'X-Violet-Token: TOKEN' \
--header 'X-Violet-App-Secret: APPSECRET' \
--header 'X-Violet-App-Id: APPID' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "dorythefish@disney.com",
    "first_name": "Paul",
    "last_name": "Sherman",
    "shipping_address": {
        "address_1": "42 Wallaby Way",
        "city": "Sydney",
        "country": "Australia",
        "postal_code": "2000",
        "state": "NSW",
        "type": "SHIPPING"
    },
    "same_address": true
}'
{
    "id": 20956,
    "token": "c8f17e9e6fec4268bc9188f039ec68ad",
    "user_id": 10397,
    "app_id": 10382,
    "developer_id": 10292,
    "customer": {
        "user_id": 10397,
        "first_name": "Paul",
        "last_name": "Sherman",
        "email": "dorythefish@disney.com",
        "name": "Paul Sherman"
    },
    "bags": [
        {
            "id": 20440,
            "order_id": 20956,
            "merchant_id": 10000,
            "app_id": 10382,
            "status": "IN_PROGRESS",
            "fulfillment_status": "PROCESSING",
            "financial_status": "UNPAID",
            "skus": [
                {
                    "id": 24987,
                    "merchant_id": 10000,
                    "app_id": 10382,
                    "product_id": "0ff55c5cda7447118d6ae1c8395f8f11",
                    "sku_id": 10064,
                    "external_id": "13884047425654",
                    "name": "GoPro - Karma Quadcopter with HERO6 Black - White - White",
                    "brand": "GoPro",
                    "thumbnail": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/6029300_ra.jpg",
                    "quantity": 1,
                    "price": 84999,
                    "weight": 13.45,
                    "available": true,
                    "status": "IN_PROGRESS",
                    "line_price": 84999
                }
            ],
            "taxes": [],
            "sub_total": 84999,
            "transactions": [],
            "external_checkout": true,
            "commission_rate": 15.0,
            "date_created": "2022-05-11T16:17:16+0000",
            "remorse_period_ends": "2022-06-10T16:17:16+0000",
            "currency": "USD",
            "external_currency": "USD",
            "channel": "APP",
            "platform": "SHOPIFY",
            "fulfillments": [],
            "merchant_name": "Violet-Besties"
        }
    ],
    "shipping_address": {
        "city": "Sydney",
        "state": "NSW",
        "country": "AU",
        "postal_code": "2000",
        "type": "SHIPPING",
        "address_1": "42 Wallaby Way"
    },
    "billing_address": {
        "city": "Sydney",
        "state": "NSW",
        "country": "AU",
        "postal_code": "2000",
        "type": "BILLING",
        "address_1": "42 Wallaby Way"
    },
    "sub_total": 84999,
    "status": "IN_PROGRESS",
    "date_created": "2022-05-11T16:17:16+0000",
    "date_last_modified": "2022-05-11T16:50:14+0000",
    "priced": false,
    "currency": "USD",
    "errors": [],
    "channel": "APP",
    "currency_symbol": "$",
    "stripe_key": "pk_test_UHg8oLvg4rrDCbvtqfwTE8qd",
    "guest": true
}

Headers

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

Path Parameters

cart_idrequired
integer

Query Parameters

async
Default: false
boolean

Body

application/json
billing_address
object

The shipping or billing address of a user placing an order

email
string

Email Address of Customer

external_id
string

ID of the Customer on the External Platform

first_namerequired
string

First Name

last_namerequired
string

Last Name

name
string
same_address
boolean

Use Same Address for Both

shipping_address
object

The shipping or billing address of a user placing an order

user_id
integer

ID of the User the Order Customer references

Response

200 - application/json
app_customer_id
string

App Customer ID

app_id
integer

ID of the App creating the order

app_name
string

Name of app that originated the order.

app_order_id
string

App Order ID

bags
object[]

Bags in the Order

billing_address
object

The shipping or billing address of a user placing an order

currency
string

Base currency of cart

currency_symbol
string

Symbol representing the desired currency

customer
object

The Customer Placing the Order

date_created
string

Date of order creation

date_last_modified
string

Date of last order update

developer_id
integer

ID of the Developer who placed

discount_total
integer

Discount Total of the Order

errors
object[]

Errors on the Order

guest
boolean
id
integer
intent_based_checkout
boolean
is_guest
boolean

Order is Guest

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

Payment intent client secret

payment_method
object

Payment Method belonging to an Order

priced
boolean

Is the cart priced

referral_id
string

Optional value used to represent an identifier in your system.

shipping_address
object

The shipping or billing address of a user placing an order

shipping_total
integer

Shipping Total of the Order

statusrequired
enum<string>

Status of the Order

Available options:
in_progress,
processing,
completed,
canceled,
partially_refunded,
refunded,
requires_action
stripe_key
string

Stripe publishable key. Use for tokenizing payment methods.

sub_total
integer

Subtotal of the Order

tax_total
integer

Tax Total of the Order

token
string
total
integer

Total of the Order

user_id
integer

ID of the User placing the order

wallet_based_checkout
boolean

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