Place an Order
Apply Shipping Method
Introduction
Getting Started
- Apps
- Pagination
- Authentication
- Environments
- Definitions
Checkout
- Overview
- Getting Started
- Merchants
- Catalog
- Carts and Bags
- Discounts
- Webhooks
- Guides
- FAQs
- Resources
- Current Platforms
Payments
- Overview
- Payment Integrations
- Payment Settings
- Setup
- Payments during Checkout
- Payouts
- Webhooks
Violet Connect
- Overview
- Setup
- Payouts
- Commissions
- Guides
- Testing
- FAQs
Relay
Product Info
Place an Order
Apply Shipping Method
Set the shipping method for each bag within a cart. By passing in an array of Objects containing the bag id and associated shipping id.
POST
/
checkout
/
cart
/
{cart_id}
/
shipping
curl --request POST \
--url https://sandbox-api.violet.io/v1/checkout/cart/{cart_id}/shipping \
--header 'Content-Type: application/json' \
--data '[
{
"bag_id": 11111,
"shipping_method_id": "07d19139fc0f4558687c1900c696f071"
}
]'
{
"id": 10000,
"token": "fz8x7gksdjsy2p9fdlonw7k9svwjso4b",
"user_id": 10000,
"app_id": 10000,
"developer_id": 10000,
"customer": {
"user_id": 10000,
"first_name": "Super",
"last_name": "Mario",
"email": "super@mar.io",
"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
}
],
"shipping_method": {
"carrier": "USPS",
"shipping_method_id": "07d19139fc0f4558687c1900c696f071",
"bag_id": 11111,
"merchant_id": 10000,
"label": "Priority Mail",
"price": 664,
"custom": false
},
"taxes": null,
"sub_total": 19998,
"shipping_total": 664,
"tax_total": 0,
"discount_total": 0,
"total": 20662,
"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": [],
"discounts": [],
"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": 664,
"tax_total": 0,
"discount_total": 0,
"total": 20662,
"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": true,
"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
}
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.
Path Parameters
Query Parameters
Body
application/json · object[]
The body is of type object[]
.
Response
200
application/json
success
Violet Order Entity
Was this page helpful?
curl --request POST \
--url https://sandbox-api.violet.io/v1/checkout/cart/{cart_id}/shipping \
--header 'Content-Type: application/json' \
--data '[
{
"bag_id": 11111,
"shipping_method_id": "07d19139fc0f4558687c1900c696f071"
}
]'
{
"id": 10000,
"token": "fz8x7gksdjsy2p9fdlonw7k9svwjso4b",
"user_id": 10000,
"app_id": 10000,
"developer_id": 10000,
"customer": {
"user_id": 10000,
"first_name": "Super",
"last_name": "Mario",
"email": "super@mar.io",
"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
}
],
"shipping_method": {
"carrier": "USPS",
"shipping_method_id": "07d19139fc0f4558687c1900c696f071",
"bag_id": 11111,
"merchant_id": 10000,
"label": "Priority Mail",
"price": 664,
"custom": false
},
"taxes": null,
"sub_total": 19998,
"shipping_total": 664,
"tax_total": 0,
"discount_total": 0,
"total": 20662,
"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": [],
"discounts": [],
"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": 664,
"tax_total": 0,
"discount_total": 0,
"total": 20662,
"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": true,
"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
}