Reports
Retrieve a list of vendor categories with filtering and pagination options.
Number of categories to retrieve.
The number of categories to skip for pagination.
Keyword to filter categories by name.
Sort order (e.g., 0 for ascending, 1 for descending).
Filter categories by status (active or inactive).
Name of the category to filter by.
Filter categories by industry ID.
Bearer token for authentication.
Successfully retrieved category list
GET /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved category list
<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</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>
This endpoint retrieves a list of vendors (sellers) based on the specified status.
Filter sellers based on their status
Bearer token for authentication.
Successfully got seller list
Invalid request
Internal server error
GET /backend/api/admin-vendor HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
This endpoint allows fetching the product list with various filters like keyword, SKU, status, and price.
The offset for pagination, indicates the starting point of the list.
The number of products to return in the response.
Search keyword to filter products by name or other attributes.
Filter products by SKU (Stock Keeping Unit).
Filter products by status (e.g., active or inactive).
Filter products by price.
Bearer token for authentication.
Successfully retrieved product list
Bad request
Internal server error
GET /backend/api/order/product-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<id>1</id>
<name>text</name>
<sku>text</sku>
<status>text</status>
<price>1</price>
</object>
This endpoint allows fetching the sales report for a specific product between a start and end date.
The ID of the product for which the sales report is to be fetched.
The start date for the sales report in YYYY-MM-DD format.
The end date for the sales report in YYYY-MM-DD format.
Bearer token for authentication.
Successfully retrieved sales report list
Bad request
Internal server error
GET /backend/api/order/sales-report-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<productId>1</productId>
<totalSales>1</totalSales>
<totalRevenue>1</totalRevenue>
<date>2025-08-06</date>
</object>
This endpoint fetches the total seller sales list based on the provided date range and sales amount range.
The start date for the report in YYYY-MM-DD format.
The end date for the report in YYYY-MM-DD format.
The minimum sales amount for the report.
The maximum sales amount for the report.
The number of results to retrieve.
The offset for the pagination.
Bearer token for authentication.
Successfully retrieved total seller sales report list
Bad request
Internal server error
GET /backend/api/settlement/total-sales-report-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<sellerId>1</sellerId>
<totalSalesAmount>1</totalSalesAmount>
<totalSalesCount>1</totalSalesCount>
<startDate>2025-08-06</startDate>
<endDate>2025-08-06</endDate>
</object>
This endpoint fetches the total seller sales report in Excel format based on the provided date range and sales amount range.
The start date for the report in YYYY-MM-DD format.
The end date for the report in YYYY-MM-DD format.
The minimum sales amount for the report.
The maximum sales amount for the report.
Bearer token for authentication.
Successfully retrieved total seller sales report in Excel format
Bad request
Internal server error
GET /backend/api/settlement/total-sales-report-excel HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>text</object>
This endpoint retrieves a list of vendor sales reports. It supports optional filtering by date range, vendor ID, and other parameters.
Number of items per page (optional).
Pagination offset (optional).
Start date of the report period (optional).
End date of the report period (optional).
Flag to specify if the report should include all vendors or just selected ones. (0 = No, 1 = Yes)
Comma-separated list of vendor IDs to filter the sales report (optional).
Bearer token for authentication.
Successfully retrieved the vendor sales report list
Bad request
Internal server error
GET /backend/api/settlement/vendor-sales-report-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got seller list</message>
</object>
Fetches the settlement report list based on the given filters.
Limit the number of records returned
Offset the records for pagination
Start date for the report filter
End date for the report filter
Include all vendors (1) or not (0)
List of vendor IDs to filter by
Filter by order status
Filter by settlement flag (0 or 1)
Bearer token for authentication.
Successfully retrieved settlement report list
Bad request, invalid parameters
Internal server error
GET /backend/api/settlement/settlement-report-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got settlement report list</message>
</object>
Fetches the settlement report in Excel format based on the given filters.
Limit the number of records returned
Offset the records for pagination
Start date for the report filter
End date for the report filter
List of vendor IDs to filter by
List of order statuses to filter by
Filter by settlement flag (0 or 1)
Bearer token for authentication.
Successfully retrieved settlement report in Excel format
Bad request, invalid parameters
Internal server error
GET /backend/api/settlement/settlement-report-excel HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>text</object>
Last updated