Manage Settlements
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 retrieves a list of orders placed by vendors based on the given query parameters.
The number of orders to return
The offset of orders to retrieve
Count of orders (0 or 1)
Bearer token for authentication.
Successfully got the complete order list
Invalid request
Internal server error
GET /backend/api/admin-vendor-order/vendor-order-list 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 retrieves a list of settlements with pagination options.
Limit the number of results returned
Skip a certain number of records before starting the results
Include count in the response to show the total number of settlements
Bearer token for authentication.
Successfully retrieved settlement list
Bad request
Internal server error
GET /backend/api/settlement 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 you to create a new settlement for a vendor order.
Bearer token for authentication.
Title of the settlement
List of vendor order IDs associated with the settlement
Successfully created new settlement
Invalid request
Internal server error
POST /backend/api/settlement HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 36
"title='text'&vendorOrderId=[1]"<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
This endpoint retrieves the details of a specific settlement by its unique identifier.
ID of the settlement to retrieve details for
Bearer token for authentication.
Successfully retrieved settlement details
Bad request
Settlement not found
Internal server error
GET /backend/api/settlement/settlement/{settlementId} 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 downloading the settlement data in Excel format based on the provided settlement ID.
ID of the settlement to export in Excel format
Bearer token for authentication.
Excel file generated successfully
Bad request
Settlement not found
Internal server error
GET /backend/api/settlement/settlement-export-excel-download HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>binary</object>
Last updated