API Documentation
Authentication APIs
- Login & Register
- Create & Manage Users
Catalog APIs
- GETList all products
- GETList all skus
- GETRetrieve a product
- GETRetrieve product variants
- GETRetrieve variant detail
- GETList all categories
- GETRetrieve product reviews
- POSTCreate product review
- GETRetrieve similar products
- GETRetrieve up sell products
- GETRetrieve cross sell products
- GETRetrieve recommended products
- POSTDatocms webhook
Cart & Checkout APIs
- Cart
- Checkout
Coupons & promotions API
Customers API
Orders APIs
Shipping APIs
Analytics
Campaigns API
Cancel order
curl --request POST \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/orders/{order_number}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"cancellation_reason": "<string>",
"refund_mode": "original_payment_mode",
"bank_account_id": "<string>",
"feedback": "<string>"
}'
{
"message": "order details",
"success": true,
"content": {
"order": {
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"status": "draft",
"payment_status": "pending",
"payment_success_date": "2023-11-07T05:31:56Z",
"customer_email": "<string>",
"customer_phone": "<string>",
"customer_note": "<string>",
"is_promotion_applied": true,
"promotion_discount_amount": 123,
"is_coupon_applied": true,
"coupon_code": "<string>",
"coupon_discount_amount": 123,
"on_subscription": true,
"subtotal": 123,
"item_total_tax": 123,
"subtotal_including_tax": 123,
"shipping_amount": 123,
"shipping_total_tax": 123,
"shipping_amount_including_tax": 123,
"total_tax": 123,
"grand_total": 123,
"loyalty_point_redeemed": 123,
"credit_balance_used": 123,
"to_be_paid": 123,
"loyalty_point_earned": 123,
"order_items_count": 123,
"order_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"on_offer": true,
"on_promotion": true,
"on_subscription": true,
"subscription_plan": "<string>",
"subscription_interval": 123,
"subscription_frequency": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true,
"selling_price": 123,
"listing_price": 123,
"promotion_discount_amount": 123,
"coupon_discount_amount": 123,
"tax_type": "GST",
"tax_rate": 123,
"tax_amount": 123,
"shipping_additional_cost": 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": "India",
"gstin": "<string>",
"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": "India",
"gstin": "<string>",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"payments": [
{
"transaction_type": "payment",
"request_number": "<string>",
"amount": 123,
"payment_status": "pending",
"payment_date": "2023-11-07T05:31:56Z",
"payment_reference_number": "<string>",
"payment_method": "Credit Card",
"icon_url": "<string>",
"card_number": "<string>",
"card_type": "Visa"
}
],
"is_cancellation_allowed": true,
"cancellation_refund_details": {
"loyalty_point": 123,
"refundable_amount": 123,
"cancellation_charges": 123,
"cancellation_charges_reason": "<string>",
"payment_mode": "original-payment-mode"
},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}
Authorizations
Access token
Path Parameters
order number
Body
original_payment_mode
, bank_transfer
verified bank account id if refund_mode = bank_transfer
feedback text
Response
draft
, awaiting_approval
, cancelled
, shipped
, delivered
, awaiting_shipment
pending
, success
, failed
, partially_paid
GST
10 digit phone number without country code.
India
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
Use in shipping details only.
Use in shipping details only.
10 digit phone number without country code.
India
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
Use in shipping details only.
Use in shipping details only.
payment
, refund
pending
, success
, failed
, partially_paid
, refund_initiated
Credit Card
, Debit Card
, Netbanking
, UPI
, Wallet
, Loyalty Point
, IMPS
, NEFT
, RTGS
masked card number e.g. ************1111
Visa
, Master Card
, Rupay
order cancellation option should be visible only if this flag is true.
to show refundable details in order cancellation ui.
loyalty point redeemed will be rollbacked and credited to user account.
amount that will be refunded to customer.
amount deducted from paid amount.
reason for cancellation charges.
payment mode for refund.
original-payment-mode
, bank-transfer
curl --request POST \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/orders/{order_number}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"cancellation_reason": "<string>",
"refund_mode": "original_payment_mode",
"bank_account_id": "<string>",
"feedback": "<string>"
}'
{
"message": "order details",
"success": true,
"content": {
"order": {
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"status": "draft",
"payment_status": "pending",
"payment_success_date": "2023-11-07T05:31:56Z",
"customer_email": "<string>",
"customer_phone": "<string>",
"customer_note": "<string>",
"is_promotion_applied": true,
"promotion_discount_amount": 123,
"is_coupon_applied": true,
"coupon_code": "<string>",
"coupon_discount_amount": 123,
"on_subscription": true,
"subtotal": 123,
"item_total_tax": 123,
"subtotal_including_tax": 123,
"shipping_amount": 123,
"shipping_total_tax": 123,
"shipping_amount_including_tax": 123,
"total_tax": 123,
"grand_total": 123,
"loyalty_point_redeemed": 123,
"credit_balance_used": 123,
"to_be_paid": 123,
"loyalty_point_earned": 123,
"order_items_count": 123,
"order_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"on_offer": true,
"on_promotion": true,
"on_subscription": true,
"subscription_plan": "<string>",
"subscription_interval": 123,
"subscription_frequency": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true,
"selling_price": 123,
"listing_price": 123,
"promotion_discount_amount": 123,
"coupon_discount_amount": 123,
"tax_type": "GST",
"tax_rate": 123,
"tax_amount": 123,
"shipping_additional_cost": 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": "India",
"gstin": "<string>",
"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": "India",
"gstin": "<string>",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"payments": [
{
"transaction_type": "payment",
"request_number": "<string>",
"amount": 123,
"payment_status": "pending",
"payment_date": "2023-11-07T05:31:56Z",
"payment_reference_number": "<string>",
"payment_method": "Credit Card",
"icon_url": "<string>",
"card_number": "<string>",
"card_type": "Visa"
}
],
"is_cancellation_allowed": true,
"cancellation_refund_details": {
"loyalty_point": 123,
"refundable_amount": 123,
"cancellation_charges": 123,
"cancellation_charges_reason": "<string>",
"payment_mode": "original-payment-mode"
},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}