Manage Sales
Retrieve a list of vendor orders with optional query parameters.
The number of orders to retrieve
The number of orders to skip before starting to collect the result set
Include the count of total records (1 for true, 0 for false)
Boolean flag to filter orders
Bearer token for authentication.
Successfully retrieved the vendor order list
Invalid query parameters
Internal server error
GET /backend/api/admin-vendor-order HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the complete order list</message>
</object>
Retrieve detailed information for a specific vendor order using the provided orderId.
The ID of the order to retrieve details for
Bearer token for authentication.
Successfully retrieved order details
Invalid orderId parameter
Order not found
Internal server error
GET /backend/api/admin-vendor-order/order-detail HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully shown the order detail</message>
<orderDetail>
<orderId>1628</orderId>
<vendorName>Vendor A</vendorName>
<orderStatus>Completed</orderStatus>
<orderDate>2024-01-01T12:00:00Z</orderDate>
<totalAmount>200.5</totalAmount>
<items>
<itemId>101</itemId>
<itemName>Product A</itemName>
<quantity>2</quantity>
<price>50.25</price>
</items>
</orderDetail>
</object>
Retrieve the order status log for a specific vendor order using the provided vendorOrderId.
The ID of the vendor order to retrieve the log list for
Bearer token for authentication.
Successfully retrieved the vendor order log list
Invalid vendorOrderId parameter
Vendor order not found
Internal server error
GET /backend/api/admin-vendor-order/vendor-order-log-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the complete seller order status log list</message>
<logList>
<logId>5001</logId>
<status>Shipped</status>
<date>2024-01-15T14:00:00Z</date>
<description>Order has been shipped to the vendor</description>
</logList>
</object>
Retrieve a complete list of order statuses.
Successfully retrieved the order status list
Internal server error
GET /backend/api/order-status/order-status-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the complete order status list</message>
<orderStatusList>
<statusId>1</statusId>
<statusName>Pending</statusName>
<description>The order is pending</description>
</orderStatusList>
</object>
Exports the details of a specific vendor order as a PDF file using the orderId, vendorId, and orderPrefixId.
The ID of the order to be exported
The ID of the vendor associated with the order
The prefix ID of the order, typically for identifying the order uniquely
Bearer token for authentication.
Successfully exported the order details as a PDF
Invalid query parameters
Order not found
Internal server error
GET /backend/api/admin-vendor-order/order-export-pdf HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully exported the order as a PDF</message>
<pdfUrl>http://139.59.67.17/backend/api/downloads/order-1628.pdf</pdfUrl>
</object>
Updates the payment status for a specific order using the orderId and paymentStatusId.
Bearer token for authentication.
16281Successfully updated the payment status
Invalid request payload
Order not found
Internal server error
POST /backend/api/order/update-payment-status HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 38
"orderId='1628'&paymentStatusId=1"<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully updated the Payment Status</message>
</object>
Retrieves the list of back orders, with options for pagination.
The number of items to return per page
10The offset for pagination
0A flag to count the total number of back orders
0Bearer token for authentication.
Successfully retrieved the back order list
Invalid query parameter
Internal server error
GET /backend/api/order/back-order-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully shown the Back Order list</message>
</object>
Retrieves the list of failed orders, with options for pagination.
The number of items to return per page
10The offset for pagination
0A flag to count the total number of failed orders
0Bearer token for authentication.
Successfully retrieved the failed order list
Invalid query parameter
Internal server error
GET /backend/api/order/failed-order-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the failed order list</message>
</object>
Retrieves the details of a specific order by its ID.
The ID of the order to retrieve details for
Bearer token for authentication.
Successfully retrieved the order details
Invalid order ID
Internal server error
GET /backend/api/order/order-detail HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully shown the order detail</message>
</object>
This API updates the main order's payment status and related details.
Bearer token for authentication.
1619212432345dsSuccessfully updated the order
Invalid request data
Internal server error
POST /backend/api/order/update-main-order HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 98
"orderId=1619&paymentStatus=2&paymentMethod=1&paymentRefId='2432345'&paymentDetail='ds'"<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully updated your order</message>
</object>
Retrieves a list of payments based on optional filters such as customer name, keyword, and date range.
The number of results to return
The offset from which to start retrieving the results
Whether to return the total count of items (0 or 1)
The name of the customer to filter the payments by
A keyword to filter the payments by (e.g., order ID, payment reference)
The start date for filtering payments
The end date for filtering payments
Bearer token for authentication.
Successfully retrieved the payment list
Invalid parameters
Internal server error
GET /backend/api/admin-vendor-payment/payment-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
Retrieves the list of live carts or the count based on the provided filters.
The number of results to return
The offset from which to start retrieving the results
Whether to return the total count of items (0 or 1)
The type of cart (e.g., 'live')
Bearer token for authentication.
Successfully retrieved the live cart list or count
Invalid parameters
Internal server error
GET /backend/api/admin-cart HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
Retrieves the details of a specific cart by ID.
The ID of the cart to retrieve
The type of cart (e.g., 'live')
Bearer token for authentication.
Successfully retrieved the cart details
Invalid cart ID or parameters
Internal server error
GET /backend/api/admin-cart/{cartId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
Sends an email notification to the customer regarding their abandoned cart.
Bearer token for authentication.
The ID of the abandoned cart
The custom message to be sent with the email
Successfully sent the email
Invalid request parameters
Internal server error
POST /backend/api/admin-cart/abandoned-cart-email HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 25
"id=1&message='text'"<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
Exports the cart details for a given customer.
Bearer token for authentication.
The ID of the customer whose cart needs to be exported.
Successfully exported cart data
Invalid request parameters
Internal server error
POST /backend/api/admin-cart/cart-export HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 21
"customerId='text'"<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
Deletes abandoned cart entries for specific customers based on customerId and guestIp.
The action to be performed (e.g., delete).
Comma-separated list of customer IDs for whom the abandoned cart details should be deleted.
Comma-separated list of guest IP addresses for whom the abandoned cart details should be deleted.
Bearer token for authentication.
Successfully deleted cart list
Invalid request parameters
Internal server error
PUT /backend/api/admin-cart/abandoned HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully Deleted Cart List...!</message>
</object>
Last updated