Orders | API Reference | Spurtcommerce

Get order counts for today

get

/vendor-order/order-counts

This endpoint retrieves the number of orders placed today.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully retrieved today's order count

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully get Today order count

400

Bad request. Invalid parameters or missing required data.

500

Internal server error.

get

/vendor-order/order-counts

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>

Get the complete list of order statuses

get

/vendor-order/vendor-order-status-list

This endpoint retrieves the complete list of available order statuses.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully retrieved the order status list

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully got the complete order status list

400

Bad request. Invalid parameters or missing required data.

500

Internal server error.

get

/vendor-order/vendor-order-status-list

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>

Get the complete list of orders with filters

get

/vendor-order/order-list

This endpoint retrieves the complete order list with optional filters like limit, offset, count, and payment process.

Query parameters

limitintegerOptional

The number of orders to retrieve.

Default: 10

offsetintegerOptional

The starting point of the data to retrieve.

Default: 0

countbooleanOptional

Set to 'true' to count the total orders without retrieving the actual data.

Default: false

paymentProcessintegerOptional

Filter orders by payment process status. 1 = Processed, 0 = Pending

Default: 1

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully retrieved the complete order list

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully got the complete order list

400

Bad request. Invalid parameters or missing required data.

500

Internal server error.

get

/vendor-order/order-list

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>

Get order details by orderId

get

/vendor-order/order-detail/{orderId}

This endpoint retrieves detailed information about a specific order using its orderId.

Path parameters

orderIdintegerRequired

The unique identifier of the order to fetch details for.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully retrieved the order detail

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully shown the order detail

400

Bad request. Invalid or missing orderId.

404

Order not found.

500

Internal server error.

get

/vendor-order/order-detail/{orderId}

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>

Fetch vendor order status log list

get

/vendor-order/vendorOrderLoglist

Retrieves a complete log list of vendor order statuses by vendorOrderId.

Query parameters

vendorOrderIdintegerRequired

The ID of the vendor order to retrieve logs for.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully retrieved the vendor order status log list

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully got the complete seller Order Status Log list

400

Invalid request parameters

500

Internal server error

get

/vendor-order/vendorOrderLoglist

GET /backend/api/vendor-order/vendorOrderLoglist?vendorOrderId=1 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>

Update the status of a vendor order

put

/vendor-order/update-order-status/{orderId}

Allows updating the status of a specific vendor order by providing the orderId and the new subOrderStatusId.

Path parameters

orderIdintegerRequired

The ID of the vendor order to update.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Body

subOrderStatusIdintegerOptional

The ID of the new sub-order status.

Example: 1

Responses

200

Successfully updated the order status

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully updated the order status

400

Invalid request parameters

404

Order not found

500

Internal server error

put

/vendor-order/update-order-status/{orderId}

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>

Get order status list based on parent

get

/vendor-order/vendor-order-status-list-based-on-parent

Fetches a list of order statuses filtered by the provided parent ID.

Query parameters

parentIdintegerRequired

The parent ID to filter order statuses.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully retrieved the order status list based on parent ID.

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully got order status list based on parent

400

Invalid parent ID provided

500

Internal server error

get

/vendor-order/vendor-order-status-list-based-on-parent

GET /backend/api/vendor-order/vendor-order-status-list-based-on-parent?parentId=1 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>

Update shipping information for a vendor order

post

/vendor-order/update-shipping-information

Updates the tracking number and shipping details for a specified vendor order.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Body

vendorOrderIdstringRequired

The ID of the vendor order.

trackingNostringRequired

The tracking number for the shipment.

Responses

200

Successfully updated shipping information

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully updated Shipping Information

400

Invalid input data

500

Internal server error

post

/vendor-order/update-shipping-information

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>

Archive a vendor order

post

/vendor-order/make-vendor-order-archive

Marks a specified vendor order as archived by providing the vendorOrderId.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Body

vendorOrderIdinteger · int32Required

The ID of the vendor order to be archived.

Responses

200

Successfully archived the order

statusnumberOptionalExample: 1

messagestringOptionalExample: Successfully order archived

400

Invalid input data

500

Internal server error

post

/vendor-order/make-vendor-order-archive

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>

hashtagGet order counts for today

hashtagGet the complete list of order statuses

hashtagGet the complete list of orders with filters

hashtagGet order details by orderId

hashtagFetch vendor order status log list

hashtagUpdate the status of a vendor order

hashtagGet order status list based on parent

hashtagUpdate shipping information for a vendor order

hashtagArchive a vendor order

Get order counts for today

Get the complete list of order statuses

Get the complete list of orders with filters

Get order details by orderId

Fetch vendor order status log list

Update the status of a vendor order

Get order status list based on parent

Update shipping information for a vendor order

Archive a vendor order