Orders
This endpoint retrieves the number of orders placed today.
Bearer token for vendor authentication
Successfully retrieved today's order count
Bad request. Invalid parameters or missing required data.
Internal server error.
GET /backend/api/vendor-order/order-counts HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully get Today order count</message>
</object>
This endpoint retrieves the complete list of available order statuses.
Bearer token for vendor authentication
Successfully retrieved the order status list
Bad request. Invalid parameters or missing required data.
Internal server error.
GET /backend/api/vendor-order/vendor-order-status-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 order status list</message>
</object>
This endpoint retrieves the complete order list with optional filters like limit, offset, count, and payment process.
The number of orders to retrieve.
10
The starting point of the data to retrieve.
0
Set to 'true' to count the total orders without retrieving the actual data.
false
Filter orders by payment process status. 1 = Processed, 0 = Pending
1
Bearer token for vendor authentication
Successfully retrieved the complete order list
Bad request. Invalid parameters or missing required data.
Internal server error.
GET /backend/api/vendor-order/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 complete order list</message>
</object>
This endpoint retrieves detailed information about a specific order using its orderId.
The unique identifier of the order to fetch details for.
Bearer token for vendor authentication
Successfully retrieved the order detail
Bad request. Invalid or missing orderId.
Order not found.
Internal server error.
GET /backend/api/vendor-order/order-detail/{orderId} 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>
Retrieves a complete log list of vendor order statuses by vendorOrderId.
The ID of the vendor order to retrieve logs for.
Bearer token for vendor authentication
Successfully retrieved the vendor order status log list
Invalid request parameters
Internal server error
GET /backend/api/vendor-order/vendorOrderLoglist 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>
</object>
Allows updating the status of a specific vendor order by providing the orderId
and the new subOrderStatusId
.
The ID of the vendor order to update.
Bearer token for vendor authentication
The ID of the new sub-order status.
1
Successfully updated the order status
Invalid request parameters
Order not found
Internal server error
PUT /backend/api/vendor-order/update-order-status/{orderId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22
"subOrderStatusId=1"
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully updated the order status</message>
</object>
Fetches a list of order statuses filtered by the provided parent ID.
The parent ID to filter order statuses.
Bearer token for vendor authentication
Successfully retrieved the order status list based on parent ID.
Invalid parent ID provided
Internal server error
GET /backend/api/vendor-order/vendor-order-status-list-based-on-parent HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got order status list based on parent</message>
</object>
Updates the tracking number and shipping details for a specified vendor order.
Bearer token for vendor authentication
The ID of the vendor order.
The tracking number for the shipment.
Successfully updated shipping information
Invalid input data
Internal server error
POST /backend/api/vendor-order/update-shipping-information HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 44
"vendorOrderId='text'&trackingNo='text'"
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully updated Shipping Information</message>
</object>
Marks a specified vendor order as archived by providing the vendorOrderId.
Bearer token for vendor authentication
The ID of the vendor order to be archived.
Successfully archived the order
Invalid input data
Internal server error
POST /backend/api/vendor-order/make-vendor-order-archive HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 19
"vendorOrderId=1"
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully order archived</message>
</object>
Last updated