Manage Sales
Get list of orders.
success response
GET /order/orderlist?limit=1&orderId=text&orderStatusId=text HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully got the order count \" or \" Successfully shown the order list"
}
Get a list of order.
success response
error response
GET /order/order-detail?orderId=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully shown the order Detail"
}
Export the order pdf.
success response
error response
GET /order/order-export-pdf?orderId=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "pdf exported"
}
List of salse graph list
success response
GET /order/sales-graph-list HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully got the sales count list"
}
Order transaction list.
success response
GET /order/transaction-list?year=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully got the transaction list"
}
Status of order changes.
success response
error response
POST /order/order-change-status HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 31
"orderId=1&orderStatusId=1"
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderId": 1,
"customerId": 1,
"currencyId": 1,
"shippingZoneId": 1,
"paymentZoneId": 1,
"shippingCountryId": 1,
"paymentCountryId": 1,
"invoiceNo": "text",
"invoicePrefix": "text",
"firstname": "text",
"lastname": "text",
"email": "text",
"telephone": "text",
"fax": "text",
"shippingFirstname": "text",
"shippingLastname": "text",
"shippingCompany": "text",
"shippingAddress1": "text",
"shippingAddress2": "text",
"shippingCity": "text",
"shippingPostcode": "text",
"shippingCountry": "text",
"shippingZone": "text",
"shippingAddressFormat": "text",
"shippingMethod": 1,
"paymentFirstname": "text",
"paymentLastname": "text",
"paymentCompany": "text",
"paymentAddress1": "text",
"paymentAddress2": "text",
"paymentCity": "text",
"paymentPostcode": "text",
"paymentCountry": "text",
"paymentZone": "text",
"paymentAddressFormat": "text",
"paymentMethod": "text",
"comment": "text",
"couponCode": "text",
"discountAmount": "text",
"amount": "text",
"total": "text",
"reward": "text",
"orderStatusId": "text",
"orderPrefixId": "text",
"affiliateId": 1,
"commision": "text",
"currencyCode": "text",
"currencyValue": 1,
"currencySymbolLeft": "text",
"currencySymbolRight": 1,
"ip": "text",
"paymentFlag": "text",
"paymentStatus": 1,
"trackingUrl": "text",
"trackingNo": 1,
"orderName": "text",
"paymentType": 1,
"paymentProcess": 1,
"paymentDetails": "text",
"backOrders": 1,
"isActive": 1,
"customerGstNo": "text",
"orderLogId": 1
}
Get order list on excel sheet.
error response
GET /order/order-excel-list?orderId=text HTTP/1.1
Host:
Authorization: text
Accept: */*
error response
{
"status": 1,
"message": "Invalid orderId"
}
Remove the exist order.
success response
error response
DELETE /order/delete-order/{id} HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Order Deleted Successfully"
}
Delete the exist orders.
success response
error response
POST /order/delete-order HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15
"orderId=[1]"
{
"status": 1,
"message": "Order Deleted Successfully"
}
success response
GET /order/orderLoglist?orderId=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully got the complete order Log list"
}
Update the payment status
success response
error response
POST /order/update-payment-status?orderId=1&paymentStatusId=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderId": 1,
"customerId": 1,
"currencyId": 1,
"shippingZoneId": 1,
"paymentZoneId": 1,
"shippingCountryId": 1,
"paymentCountryId": 1,
"invoiceNo": "text",
"invoicePrefix": "text",
"firstname": "text",
"lastname": "text",
"email": "text",
"telephone": "text",
"fax": "text",
"shippingFirstname": "text",
"shippingLastname": "text",
"shippingCompany": "text",
"shippingAddress1": "text",
"shippingAddress2": "text",
"shippingCity": "text",
"shippingPostcode": "text",
"shippingCountry": "text",
"shippingZone": "text",
"shippingAddressFormat": "text",
"shippingMethod": 1,
"paymentFirstname": "text",
"paymentLastname": "text",
"paymentCompany": "text",
"paymentAddress1": "text",
"paymentAddress2": "text",
"paymentCity": "text",
"paymentPostcode": "text",
"paymentCountry": "text",
"paymentZone": "text",
"paymentAddressFormat": "text",
"paymentMethod": "text",
"comment": "text",
"couponCode": "text",
"discountAmount": "text",
"amount": "text",
"total": "text",
"reward": "text",
"orderStatusId": 1,
"orderPrefixId": "text",
"affiliateId": 1,
"commision": 1,
"currencyCode": "text",
"currencyValue": "text",
"currencySymbolLeft": "text",
"currencySymbolRight": "text",
"ip": "text",
"trackingUrl": "text",
"trackingNo": "text",
"orderName": "text",
"paymentType": "text",
"paymentProcess": 1,
"paymentDetails": "text",
"backOrders": 1,
"isActive": 1,
"customerGstNo": "text"
}
Update the shipping information.
success response
error response
POST /order/update-shipping-information HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54
"orderId=1&trackingUrl='text'&trackingNo='text'"
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderId": 1,
"customerId": 1,
"currencyId": 1,
"shippingZoneId": 1,
"paymentZoneId": 1,
"shippingCountryId": 1,
"paymentCountryId": 1,
"invoiceNo": "text",
"invoicePrefix": "text",
"firstname": "text",
"lastname": "text",
"email": "text",
"telephone": "text",
"fax": "text",
"shippingFirstname": "text",
"shippingLastname": "text",
"shippingCompany": "text",
"shippingAddress1": "text",
"shippingAddress2": "text",
"shippingCity": "text",
"shippingPostcode": "text",
"shippingCountry": "text",
"shippingZone": "text",
"shippingAddressFormat": "text",
"shippingMethod": 1,
"paymentFirstname": "text",
"paymentLastname": "text",
"paymentCompany": "text",
"paymentAddress1": "text",
"paymentAddress2": "text",
"paymentCity": "text",
"paymentPostcode": "text",
"paymentCountry": "text",
"paymentZone": "text",
"paymentAddressFormat": "text",
"paymentMethod": "text",
"comment": "text",
"couponCode": "text",
"discountAmount": "text",
"amount": "text",
"total": "text",
"reward": "text",
"orderStatusId": 1,
"orderPrefixId": "text",
"affiliateId": 1,
"commision": "text",
"currencyCode": "text",
"currencyValue": "text",
"currencySymbolLeft": "text",
"currencySymbolRight": "text",
"ip": "text",
"paymentFlag": 1,
"paymentStatus": 1,
"trackingUrl": "text",
"trackingNo": "text",
"orderName": "text",
"paymentType": "text",
"paymentProcess": 1,
"paymentDetails": "text",
"backOrders": 1,
"isActive": 1,
"customerGstNo": "text"
}
Update the order product shipping information
success response
error response
POST /order/update-order-product-shipping-information HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 61
"orderProductId=1&trackingUrl='text'&trackingNo='text'"
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderProductId": 1,
"productId": 1,
"orderProductPrefixId": "text",
"orderId": 1,
"name": "text",
"model": "text",
"quantity": 1,
"productPrice": "text",
"discountAmount": "text",
"basePrice": "text",
"taxType": 1,
"taxValue": 1,
"total": "text",
"discountedAmount": 1,
"orderStatusId": 1,
"trackingUrl": "text",
"trackingNo": "text",
"trace": "text",
"tax": "text",
"cancelRequest": 1,
"cancelRequestStatus": 1,
"cancelReason": "text",
"cancelReasonDescription": "text",
"isActive": 1,
"skuName": "text",
"couponDiscountAmount": 1
}
Update the order product status
success response
error response
PUT /order/update-order-product-status/{orderProductId} HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 19
"orderStatusId=1"
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderProductId": 1,
"productId": 1,
"orderProductPrefixId": "text",
"orderId": 1,
"name": "text",
"model": "text",
"quantity": 1,
"productPrice": "text",
"discountAmount": "text",
"basePrice": "text",
"taxType": 1,
"taxValue": 1,
"total": "text",
"discountedAmount": "text",
"orderStatusId": 1,
"trackingUrl": "text",
"trackingNo": "text",
"trace": "text",
"tax": "text",
"cancelRequest": 1,
"cancelRequestStatus": 1,
"cancelReason": "text",
"cancelReasonDescription": "text",
"isActive": 1,
"skuName": "text",
"couponDiscountAmount": 1
}
Get list of order product log.
success response
GET /order/order-product-log-list?orderProductId=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully got the complete Order Product Log list"
}
List of order cancel request.
success response
GET /order/order-cancel-request-list?limit=1&keyword=text HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully got the order count \" or \" Successfully shown the order product cancel list"
}
Update the order cancel request.
success response
error response
PUT /order/update-order-cancel-request/{orderProductId} HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20
"cancelStatusId=1"
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderProductId": 1,
"productId": 1,
"orderProductPrefixId": "text",
"orderId": 1,
"name": "text",
"model": "text",
"quantity": 1,
"productPrice": "text",
"discountAmount": "text",
"basePrice": "text",
"taxType": 1,
"taxValue": 1,
"total": "text",
"discountedAmount": 1,
"orderStatusId": 1,
"trackingUrl": "text",
"trackingNo": "text",
"trace": "text",
"tax": 1,
"cancelRequest": 1,
"cancelRequestStatus": 1,
"cancelReason": "text",
"cancelReasonDescription": "text",
"isActive": 1,
"skuName": "text",
"couponDiscountAmount": 1
}
Update the bulk order cancel request
success response
error response
GET /order/update-bulk-order-cancel-request HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully accepted the cancelled orders \" or \" Successfully rejected the cancelled orders"
}
Excel list of order cancel.
error response
GET /order/order-cancel-excel-list HTTP/1.1
Host:
Authorization: text
Accept: */*
error response
{
"status": 1,
"message": "Invalid orderProductId"
}
Excel list of bulk order cancel.
error response
GET /order/bulk-order-cancel-excel-list?status=1&keyword=text HTTP/1.1
Host:
Authorization: text
Accept: */*
error response
{
"status": 1,
"message": "file is empty"
}
List of bulk order.
success response
error response
GET /order/back-order-list?limit=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got the order count \" or \" Successfully shown the order list"
}
List of failed order.
success response
GET /order/failed-order-list?limit=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "uccessfully got count \" or \" Successfully got the failed order list"
}
Update the main order.
success response
error response
POST /order/update-main-order HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 99
"orderId=1&paymentMethod='text'&paymentRefId='text'&paymentStatus=1&paymentDetail='text'"
{
"status": 1,
"message": "Successfully updated your order"
}
List of order count.
success response
GET /order/order-count-for-list HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully shown the order count"
}
List of salse report.
success response
GET /order/sales-report-list?limit=1&productId=text HTTP/1.1
Host:
Authorization: text
Accept: */*
success response
{
"status": 1,
"message": "Successfully got the sales report list"
}
Order Status
Add a category order status.
success response
error response
POST /order-status/create-order-status HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 118
"name='text'&colorCode='text'&priority=1&status=1&parentId=1&isAdmin=1&isVendor=1&isBuyer=1&isApi=1"
{
"name": "text",
"colorCode": "text",
"priority": 1,
"isActive": "text",
"parentId": "text",
"createdDate": "text",
"orderStatusId": 1
}
Update a category order status.
success response
error response
PUT /order-status/update-order-status/{id} HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 118
"name='text'&colorCode='text'&priority=1&status=1&parentId=1&isAdmin=1&isVendor=1&isBuyer=1&isApi=1"
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderStatusId": 1,
"name": "text",
"isActive": "text",
"priority": "text",
"parentId": 1,
"defaultStatus": 1,
"colorCode": "text"
}
Get list of the category order status.
success response
error response
PUT /order-status/update-order-fullfillment-status/{id} HTTP/1.1
Host:
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 12
"status=1"
{
"createdBy": 1,
"createdDate": "2025-08-29T19:57:19.485Z",
"modifiedBy": 1,
"modifiedDate": "2025-08-29T19:57:19.485Z",
"orderStatusId": 1,
"name": "text",
"isActive": 1,
"priority": 1,
"parentId": 1,
"defaultStatus": 1,
"isAdmin": 1,
"isVendor": 1,
"isBuyer": 1,
"isApi": 1,
"colorCode": "text"
}
Get list of order fullfillment status.
success response
error response
GET /order-status/order-fullfillment-status-list?limit=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got the complete Order fullfillment status list."
}
Get the order status list based on parent.
success response
error response
GET /order-status/order-status-list-based-on-parent?limit=text&parentId=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got order status list based on parent."
}
Get list of order status.
success response
error response
GET /order-status/order-status-list?limit=1 HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got the complete order status list."
}
Delete a order status.
success response
error response
DELETE /order-status/delete-order-status/{id} HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully deleted the order status. \" or \" Status is mapped with order product, so you cant delete it."
}
Last updated