Auth
- POSTAnonymous user
- POSTLogin with phone
- POSTLogin with email
- POSTLogin with whatsapp
- POSTLogin with password
- POSTVerify OTP
- POSTRegister with phone
- POSTRegister with email
- POSTRegister with whatsapp
- POSTRegister with password
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate OTP
- POSTLogout user
- POSTCheck email/phone verification status
Catalog
Carts
- POSTCreate cart
- GETRetrieve cart detail
- DELDelete cart
- GETRetrieve cart using user id
- DELDelete cart using user id
- POSTAdd/delete cart item
- POSTUpdate cart address
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
Coupons & promotions
Customers
KYC
Orders
Shipping
Analytics
Campaigns
Carts
Update cart address
Carts
Update cart address
Update billing and shipping address
POST
/
carts
/
{id}
/
address
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/carts/{id}/address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"billing_address_id": "<string>",
"shipping_address_id": "<string>"
}'
{
"message": "Address updated successfully",
"success": true,
"content": {
"cart": {
"id": "<string>",
"active": true,
"customer_email": "[email protected]",
"customer_phone": "+919988776655",
"customer_note": "<string>",
"is_promotion_applied": true,
"is_coupon_applied": true,
"coupon_code": "<string>",
"promotion_discount_amount": 1,
"coupon_discount_amount": 1,
"subtotal": 1,
"items_tax_amount": 1,
"subtotal_including_tax": 1,
"shipping_amount": 1,
"shipping_tax_amount": 1,
"shipping_amount_including_tax": 1,
"total_tax": 1,
"grand_total": 1,
"credit_balance_used": 1,
"to_be_paid": 1,
"loyalty_points_redeemed": 1,
"loyalty_points_earned": 1,
"cart_items_count": 1,
"cart_items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"sku": "SKU1254",
"slug": "<string>",
"product_name": "<string>",
"variant_name": "<string>",
"product_type": "physical",
"product_image_url": "<string>",
"stock_available": true,
"on_offer": true,
"on_subscription": true,
"on_promotion": true,
"quantity": 123,
"is_free_item": true,
"free_quantity": 123,
"promotion_discount_amount": 123,
"coupon_discount_amount": 123,
"price_including_tax": false,
"listing_price": 200,
"selling_price": 199,
"selling_price_excluding_tax": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"shipping_additional_cost": 123,
"tax_type": "GST",
"tax_rate": 123,
"tax_amount": 123,
"associated_options": {
"background_color": {
"name": "Background Color",
"value": {
"name": "Blue",
"hexcode": "#0000FF"
},
"type": "color"
},
"size": {
"name": "Size",
"value": "Large",
"type": "single-select"
}
},
"subscriptions": [
{
"id": "<string>",
"subscription_plan": "<string>",
"subscription_price": 123,
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"fulfill_separately": false,
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123,
"minimum_quantity": 123,
"billing_trial_days": 123
}
]
}
],
"billing_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"shipping_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"currency": {
"name": "Indian Rupee",
"code": "INR",
"symbol": "₹"
},
"metadata": {},
"expires_at": "2023-11-07T05:31:56Z"
}
}
}
Authorizations
Access token
Path Parameters
Cart ID
Body
application/json
Update billing and shipping address during checkout
For registered users where address is previously added
For registered users where address is previously added
For guest checkout where address is not saved
Response
200
application/json
OK
The response is of type object
.
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/carts/{id}/address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"billing_address_id": "<string>",
"shipping_address_id": "<string>"
}'
{
"message": "Address updated successfully",
"success": true,
"content": {
"cart": {
"id": "<string>",
"active": true,
"customer_email": "[email protected]",
"customer_phone": "+919988776655",
"customer_note": "<string>",
"is_promotion_applied": true,
"is_coupon_applied": true,
"coupon_code": "<string>",
"promotion_discount_amount": 1,
"coupon_discount_amount": 1,
"subtotal": 1,
"items_tax_amount": 1,
"subtotal_including_tax": 1,
"shipping_amount": 1,
"shipping_tax_amount": 1,
"shipping_amount_including_tax": 1,
"total_tax": 1,
"grand_total": 1,
"credit_balance_used": 1,
"to_be_paid": 1,
"loyalty_points_redeemed": 1,
"loyalty_points_earned": 1,
"cart_items_count": 1,
"cart_items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"sku": "SKU1254",
"slug": "<string>",
"product_name": "<string>",
"variant_name": "<string>",
"product_type": "physical",
"product_image_url": "<string>",
"stock_available": true,
"on_offer": true,
"on_subscription": true,
"on_promotion": true,
"quantity": 123,
"is_free_item": true,
"free_quantity": 123,
"promotion_discount_amount": 123,
"coupon_discount_amount": 123,
"price_including_tax": false,
"listing_price": 200,
"selling_price": 199,
"selling_price_excluding_tax": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"shipping_additional_cost": 123,
"tax_type": "GST",
"tax_rate": 123,
"tax_amount": 123,
"associated_options": {
"background_color": {
"name": "Background Color",
"value": {
"name": "Blue",
"hexcode": "#0000FF"
},
"type": "color"
},
"size": {
"name": "Size",
"value": "Large",
"type": "single-select"
}
},
"subscriptions": [
{
"id": "<string>",
"subscription_plan": "<string>",
"subscription_price": 123,
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"fulfill_separately": false,
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123,
"minimum_quantity": 123,
"billing_trial_days": 123
}
]
}
],
"billing_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"shipping_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"currency": {
"name": "Indian Rupee",
"code": "INR",
"symbol": "₹"
},
"metadata": {},
"expires_at": "2023-11-07T05:31:56Z"
}
}
}