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

Archeive Orders

PreviousSalesNextBack Orders

Last updated 4 months ago

Get Archived Order list

get

Fetches a list of archived orders based on optional filters such as limit, offset, keyword, sku, status, price, and date range.

Query parameters
limitintegerOptional

Maximum number of results to return.

Default: 10
offsetintegerOptional

Number of results to skip.

Default: 0
keywordstringOptional

Keyword to filter results.

skustringOptional

Product SKU to filter results.

statusstringOptional

Order status to filter results.

pricenumberOptional

Price to filter results.

Default: 0
countintegerOptional

Whether to include the total count (0 or 1).

startDatestringOptional

Start date for the range filter (format: YYYY-MM-DD).

endDatestringOptional

End date for the range filter (format: YYYY-MM-DD).

keyUpbooleanOptional

Whether to enable key-up filter (true or false).

Default: false
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the Archived Order list
400
Invalid input data
500
Internal server error
get
GET /backend/api/vendor-order/archive-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 archive list</message>
</object>

Get Archived Order Detail

get

Fetches detailed information of a specific archived order based on the provided vendorOrderArchiveId.

Path parameters
vendorOrderArchiveIdintegerRequired

The ID of the archived order to fetch details for.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the Archive Order Detail
400
Invalid input data
500
Internal server error
get
GET /backend/api/vendor-order/archive-order-detail/{vendorOrderArchiveId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully shown the archive order detail</message>
</object>
  • GETGet Archived Order list
  • GETGet Archived Order Detail
  • POSTRevoke Vendor Order Archive

Revoke Vendor Order Archive

post

Revokes the archive status of a specific vendor order.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
vendorOrderIdinteger ยท int32Required

The ID of the vendor order to revoke archive status.

Responses
200
Successfully revoked the order archive
400
Invalid request or missing parameters
500
Internal server error
post
POST /backend/api/vendor-order/revoke-vendor-order-archive HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 19

{
  "vendorOrderId": 1
}
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully revoked order archive</message>
</object>