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

Failed Orders

PreviousBack OrdersNextOrders

Last updated 4 months ago

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>
  • 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