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
Orders
Shipping
Analytics
Campaigns
Update cart address
Update billing and shipping 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
For registered users where address is previously added
For registered users where address is previously added
For guest checkout where address is not saved
null value for guest checkout.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
"India"Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
"123456789"
Use in billing & shipping details only.
null value for guest checkout.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
"India"Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
"123456789"
Use in billing & shipping details only.
Response
"Address updated successfully"
This cart model is structured to capture a wide range of details, facilitating accurate representation and management of user shopping carts in an e-commerce platform.
Unique identifier for the cart.
Indicates whether the cart is currently active or inactive.
Email of the customer associated with the cart.
Phone number of the customer.
"+919988776655"
customer note for shipping or product customization.
Indicates if a promotion is applied or not.
Indicates if a coupon is applied or not.
Code of the applied coupon.
Discount amount due to promotions(If Applied).
x >= 0Discount amount due to the coupon.
x >= 0Subtotal amount for items in the cart.
x >= 0Total tax amount for items.
x >= 0Subtotal including tax.
x >= 0Shipping cost.
x >= 0Total tax amount for shipping.
x >= 0Shipping cost including tax.
x >= 0Total tax amount for the entire cart.
x >= 0Grand total amount for the cart.
x >= 0Amount of credit balance used.
x >= 0Amount to be paid by the customer.
x >= 0Number of loyalty points redeemed.
x >= 0Number of loyalty points earned.
x >= 0Number of items in the cart.
x >= 0List containing detailed information about each item in the cart.
This Cart Item model captures the attributes of a cart item, including product details, pricing information, subscription details, and other relevant information related to Cart Item.
Unique identifier for the product.
Unique identifier for the product.
Stock Keeping Unit, a unique identifier for the product within inventory.
"SKU1254"
Unique slug for the product
Name of the product.
Name of the variant.
physical, digital, bundle "physical"
URL pointing to the product image.
Indicates whether the product is currently in stock.
Indicates whether the product is currently on offer.
Indicates whether the product is currently on a subscription.
Indicates whether the product is part of a promotion.
The quantity of the product in the cart.
Indicates if the product is offered for free.
Quantity of the product that is free.
Discount amount due to promotions.
Discount amount due to applied coupons.
false
200
199
Additional cost for shipping associated with the product.
Type of tax applied (e.g., GST).
"GST"The rate of tax applied to the product.
The total tax amount for the product.
Used when variant_id is not null.
{
"background_color": {
"name": "Background Color",
"value": { "name": "Blue", "hexcode": "#0000FF" },
"type": "color"
},
"size": {
"name": "Size",
"value": "Large",
"type": "single-select"
}
}
Billing interval determines the frequency for which the customer is charged for the subscription itself.
weekly, monthly, annually "monthly"
Optionally limit the number of times this subscription will invoice the customer.
order interval defines the frequency of when the subscription sends customers the product
weekly, monthly, annully "monthly"
By default this is set to unlimited, meaning the subscription will fulfill indefinitely. Changing the Limit to 10 would force the subscription to end after the tenth interval had been fulfilled.
The quantity of the plan to which the customer should be subscribed
Use in digital product only for trial period
Details of the billing address.
null value for guest checkout.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
"India"Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
"123456789"
Use in billing & shipping details only.
Details of the shipping address.
null value for guest checkout.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
"India"Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
"123456789"
Use in billing & shipping details only.
Additional metadata associated with the cart. The example includes an empty object in the list.
the expiration timestamp of the shopping cart. .
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"
}
}
}