Reports

PreviousProduct Configuration NextSellers

Last updated 4 months ago

Get vendor category list

get

Retrieve a list of vendor categories with filtering and pagination options.

Query parameters

limitintegerOptional

Number of categories to retrieve.

offsetintegerOptional

The number of categories to skip for pagination.

keywordstringOptional

Keyword to filter categories by name.

sortOrderintegerOptional

Sort order (e.g., 0 for ascending, 1 for descending).

statusintegerOptional

Filter categories by status (active or inactive).

namestringOptional

Name of the category to filter by.

industryIdintegerOptional

Filter categories by industry ID.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved category list

get

GET /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully retrieved category list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get order status list

get

Retrieve a complete list of order statuses.

Responses

200

Successfully retrieved the order status list

500

Internal server error

get

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>

Retrieve seller list

get

This endpoint retrieves a list of vendors (sellers) based on the specified status.

Query parameters

statusintegerOptional

Filter sellers based on their status

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully got seller list

400

Invalid request

500

Internal server error

get

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>

Retrieve product list with filters

get

This endpoint allows fetching the product list with various filters like keyword, SKU, status, and price.

Query parameters

offsetinteger · int32Required

The offset for pagination, indicates the starting point of the list.

limitinteger · int32Required

The number of products to return in the response.

keywordstringOptional

Search keyword to filter products by name or other attributes.

skustringOptional

Filter products by SKU (Stock Keeping Unit).

statusstringOptional

Filter products by status (e.g., active or inactive).

priceinteger · int32Optional

Filter products by price.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved product list

400

Bad request

500

Internal server error

get

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>

Retrieve sales report list for a product within a date range

get

This endpoint allows fetching the sales report for a specific product between a start and end date.

Query parameters

productIdinteger · int32Required

The ID of the product for which the sales report is to be fetched.

startDatestring · dateRequired

The start date for the sales report in YYYY-MM-DD format.

endDatestring · dateRequired

The end date for the sales report in YYYY-MM-DD format.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved sales report list

400

Bad request

500

Internal server error

get

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-06-18</date>
</object>

Retrieve total seller sales list within a specified date and amount range

get

This endpoint fetches the total seller sales list based on the provided date range and sales amount range.

Query parameters

startDatestring · dateRequired

The start date for the report in YYYY-MM-DD format.

endDatestring · dateRequired

The end date for the report in YYYY-MM-DD format.

amountFromnumber · floatRequired

The minimum sales amount for the report.

amountTonumber · floatRequired

The maximum sales amount for the report.

limitintegerOptional

The number of results to retrieve.

offsetintegerOptional

The offset for the pagination.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved total seller sales report list

400

Bad request

500

Internal server error

get

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-06-18</startDate>
	<endDate>2025-06-18</endDate>
</object>

Retrieve total seller sales report in Excel format within a specified date and amount range

get

This endpoint fetches the total seller sales report in Excel format based on the provided date range and sales amount range.

Query parameters

startDatestring · dateRequired

The start date for the report in YYYY-MM-DD format.

endDatestring · dateRequired

The end date for the report in YYYY-MM-DD format.

amountFromnumber · floatRequired

The minimum sales amount for the report.

amountTonumber · floatRequired

The maximum sales amount for the report.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved total seller sales report in Excel format

Responsestring

400

Bad request

500

Internal server error

get

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>

Retrieve vendor sales report list

get

This endpoint retrieves a list of vendor sales reports. It supports optional filtering by date range, vendor ID, and other parameters.

Query parameters

limitintegerOptional

Number of items per page (optional).

offsetintegerOptional

Pagination offset (optional).

startDatestring · dateOptional

Start date of the report period (optional).

endDatestring · dateOptional

End date of the report period (optional).

allVendorinteger · enumOptional

Flag to specify if the report should include all vendors or just selected ones. (0 = No, 1 = Yes)

Possible values:

vendorsIdstringOptional

Comma-separated list of vendor IDs to filter the sales report (optional).

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the vendor sales report list

400

Bad request

500

Internal server error

get

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>

Get settlement report list

get

Fetches the settlement report list based on the given filters.

Query parameters

limitintegerOptional

Limit the number of records returned

offsetintegerOptional

Offset the records for pagination

startDatestring · dateOptional

Start date for the report filter

endDatestring · dateOptional

End date for the report filter

allVendorinteger · enumOptional

Include all vendors (1) or not (0)

Possible values:

vendorsIdinteger[]Optional

List of vendor IDs to filter by

orderStatusintegerOptional

Filter by order status

settlementFlaginteger · enumOptional

Filter by settlement flag (0 or 1)

Possible values:

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved settlement report list

400

Bad request, invalid parameters

500

Internal server error

get

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>

Get settlement report in Excel format

get

Fetches the settlement report in Excel format based on the given filters.

Query parameters

limitintegerOptional

Limit the number of records returned

offsetintegerOptional

Offset the records for pagination

startDatestring · dateRequired

Start date for the report filter

endDatestring · dateRequired

End date for the report filter

vendorsIdinteger[]Required

List of vendor IDs to filter by

orderStatusinteger[]Optional

List of order statuses to filter by

settlementFlaginteger · enumOptional

Filter by settlement flag (0 or 1)

Possible values:

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved settlement report in Excel format

Responsestring

400

Bad request, invalid parameters

500

Internal server error

get

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>