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
Orders
Retrieve all orders
Orders
Retrieve all orders
list customers all orders
GET
/
orders
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"orders": [
{
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"status": "draft",
"payment_status": "pending",
"payment_success_date": "2023-11-07T05:31:56Z",
"has_refund": true,
"on_subscription": true,
"grand_total": 123,
"loyalty_point_redeemed": 123,
"credit_balance_used": 123,
"to_be_paid": 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
}
],
"customer_note": "<string>",
"loyalty_point_earned": 123,
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
}
}Authorizations
Access token
Query Parameters
page number of pagination list
Required range:
x >= 1no of rows per page
Required range:
x >= 1JSON string format: {"field1":"asc", "field2":"desc"}
Example:
"{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}"
array of string
user id
Response
200
application/json
OK
order list model
Unique number associated with the order.
Date and time when the order was placed.
Current status of the order (e.g., "pending," "processing," "shipped," etc.).
Available options:
draft, awaiting_approval, confirmed, partially_scheduled, awaiting_shipment, shipped, partially_shipped, undelivered, partially_undelivered, return_to_origin, partially_return_to_origin, complete, partially_delivered, cancelled Current payment status of the order (e.g., "pending," "success," "failed").
Available options:
pending, success, failed, partially_paid Date and time when the payment for the order was successfully processed.
Indicates whether the order has a refund associated with it or not.
Indicates whether the order includes subscription items.
Total amount for the order, including all items, taxes, and discounts.
Number of loyalty points redeemed in the order.
Amount of credit balance used in the order.
Amount remaining to be paid for the order.
Total count of items included in the order.
Allowed value:
"GST"Example:
"GST"
pagination metadata structure
Example:
{
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"orders": [
{
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"status": "draft",
"payment_status": "pending",
"payment_success_date": "2023-11-07T05:31:56Z",
"has_refund": true,
"on_subscription": true,
"grand_total": 123,
"loyalty_point_redeemed": 123,
"credit_balance_used": 123,
"to_be_paid": 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
}
],
"customer_note": "<string>",
"loyalty_point_earned": 123,
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
}
}