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 order returns
Orders
Retrieve all order returns
Retrieve all order returns
GET
/
orders
/
returns
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders/returns \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"returns": [
{
"request_number": "<string>",
"status": "<string>",
"return_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"selling_price": 123,
"tax_type": "<string>",
"tax_rate": 123,
"quantity": 123,
"resolution": "refund",
"return_reason": "<string>"
}
],
"subtotal": 123,
"shipping_amount": 123,
"total_tax": 123,
"grand_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"approved_at": "2023-11-07T05:31:56Z",
"shipped_at": "2023-11-07T05:31:56Z",
"received_at": "2023-11-07T05:31:56Z",
"original_order_number": "<string>",
"original_order_delivered_at": "2023-11-07T05:31:56Z",
"replacement_order_number": "<string>",
"replacement_order_date": "2023-11-07T05:31:56Z",
"replacement_order_amount": 123,
"refund": [
{
"request_number": "<string>",
"refund_amount": 123,
"refund_date": "2023-11-07T05:31:56Z",
"status": "pending",
"payment_mode": "PaymentGateway",
"payment_method": "<string>",
"payment_reference_number": "<string>",
"bank_account_number": "<string>",
"bank_name": "<string>",
"refund_remarks": "<string>"
}
]
}
]
}
}
Authorizations
Access token
Response
200 - application/json
OK
Available options:
refund
, replacement
Allowed value:
"GST"
Order refund model
Available options:
pending
, approved
, success
, failed
Available options:
PaymentGateway
, ClubAI
, BankTransfer
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders/returns \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"returns": [
{
"request_number": "<string>",
"status": "<string>",
"return_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"selling_price": 123,
"tax_type": "<string>",
"tax_rate": 123,
"quantity": 123,
"resolution": "refund",
"return_reason": "<string>"
}
],
"subtotal": 123,
"shipping_amount": 123,
"total_tax": 123,
"grand_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"approved_at": "2023-11-07T05:31:56Z",
"shipped_at": "2023-11-07T05:31:56Z",
"received_at": "2023-11-07T05:31:56Z",
"original_order_number": "<string>",
"original_order_delivered_at": "2023-11-07T05:31:56Z",
"replacement_order_number": "<string>",
"replacement_order_date": "2023-11-07T05:31:56Z",
"replacement_order_amount": 123,
"refund": [
{
"request_number": "<string>",
"refund_amount": 123,
"refund_date": "2023-11-07T05:31:56Z",
"status": "pending",
"payment_mode": "PaymentGateway",
"payment_method": "<string>",
"payment_reference_number": "<string>",
"bank_account_number": "<string>",
"bank_name": "<string>",
"refund_remarks": "<string>"
}
]
}
]
}
}