Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
        • Support
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
        • Support-Category
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
        • Support
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Page 1
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product Localisation
        • Product List
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
        • Support
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce
  2. Vendor API
  3. Sales

Orders

PreviousFailed OrdersNextQuotation Request

Last updated 3 months ago

Get order counts for today

get

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
400
Bad request. Invalid parameters or missing required data.
500
Internal server error.
get
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

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
400
Bad request. Invalid parameters or missing required data.
500
Internal server error.
get
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

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
400
Bad request. Invalid parameters or missing required data.
500
Internal server error.
get
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

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
400
Bad request. Invalid or missing orderId.
404
Order not found.
500
Internal server error.
get
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

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
400
Invalid request parameters
500
Internal server error
get
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>

Get order status list based on parent

get

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.
400
Invalid parent ID provided
500
Internal server error
get
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>
  • GETGet order counts for today
  • GETGet the complete list of order statuses
  • GETGet the complete list of orders with filters
  • GETGet order details by orderId
  • GETFetch vendor order status log list
  • PUTUpdate the status of a vendor order
  • GETGet order status list based on parent
  • POSTUpdate shipping information for a vendor order
  • POSTArchive a vendor order

Update the status of a vendor order

put

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
400
Invalid request parameters
404
Order not found
500
Internal server error
put
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>

Update shipping information for a vendor order

post

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
400
Invalid input data
500
Internal server error
post
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

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
400
Invalid input data
500
Internal server error
post
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>