Catalog
- GETRetrieve all products
- POSTCreate product
- GETRetrieve skus
- GETRetrieve product details
- PUTUpdate product details
- DELDelete product
- GETRetrieve product variants
- POSTCreate variant
- POSTUpdate variants in bulk
- GETRetrieve a variant details
- PUTUpdate a variant
- DELDelete a variant
- GETRetrieve product inventory
- POSTUpdate product inventory
- GETRetrieve product inventory activities
- PUTUpdate product inventory activities
- POSTCreate product inventory activities
- GETRetrieve product reviews
- GETRetrieve product review
- PUTUpdate product review
- DELDelete product review
- GETRetrieve all categories
- POSTCreate category
- GETRetrieve category
- PUTUpdate category
- DELDelete category
- GETRetrieve all attributes
- POSTCreate attribute
- GETRetrieve attribute
- PUTUpdate attribute
- DELDelete attribute
- POSTAdd product pricing
- PUTUpdate product pricing
- DELDelete product pricing
- POSTAdd product image
- PUTUpdate product image
- DELDelete product image
- GETRetrive sku detail
Auth
- PUTActivate user account
- PUTDeactivate user account
- GETCheck domain availability
- GETRetrieve all roles
- POSTCreate new role
- PUTUpdate role
- DELDelete role
- GETRetrieve all permissions of a role
- POSTAdd permission to role
- DELRemove permission from role
- GETRetrieve all members
- POSTCreate new member
- GETRetrieve member detail
- PUTUpdate member details
- DELDelete member
- GETRetrieve all roles of a member
- POSTAssigne role to member
- DELRemove role from member
Coupons & promotions API
- GETList all coupons
- POSTCreate coupon
- GETRetrieve coupon details
- PUTUpdate coupon
- DELDelete coupon
- GETList all coupon codes
- POSTAdd coupon code
- GETList all coupon customers
- GETRetrieve coupon usage
- GETList all promotions
- POSTCreate promotion
- GETRetrieve promotion details
- PUTUpdate promotion
- DELDelete promotion
- GETList all promotion usage
- GETList all promotion customers
Warehouse
Orders API
Shipping API
Customers API
Segments API
Payments API
Media Gallery API
Orders API
Retrieve order details
GET
/
orders
/
{order-number}
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/orders/{order-number} \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"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"
}
],
"shipments": [
{
"reference_number": "<string>",
"status": "pending",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"shipping_label_url": "<string>",
"awb_no": "<string>",
"eta_delivery": "<string>",
"shipped_date": "2023-11-07T05:31:56Z",
"delivered_date": "2023-11-07T05:31:56Z",
"cancellation_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
order number
Response
200 - application/json
OK
Available options:
draft
, awaiting_approval
, cancelled
, shipped
, delivered
, awaiting_shipment
Available options:
pending
, success
, failed
, partially_paid
Available options:
GST
10 digit phone number without country code.
Available options:
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.
Available options:
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.
Available options:
payment
, refund
Available options:
pending
, success
, failed
, partially_paid
, refund_initiated
Available options:
Credit Card
, Debit Card
, Netbanking
, UPI
, Wallet
, Loyalty Point
, IMPS
, NEFT
, RTGS
masked card number e.g. ************1111
Available options:
Visa
, Master Card
, Rupay
Available options:
pending
, approved
, shipped
, delivered
, cancelled
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/orders/{order-number} \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"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"
}
],
"shipments": [
{
"reference_number": "<string>",
"status": "pending",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"shipping_label_url": "<string>",
"awb_no": "<string>",
"eta_delivery": "<string>",
"shipped_date": "2023-11-07T05:31:56Z",
"delivered_date": "2023-11-07T05:31:56Z",
"cancellation_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
}
}