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. Store API
  3. Account Settings

My Order

PreviousCustomerNextMy Quotation

Last updated 4 months ago

Get Order List Count

get
Query parameters
limitintegerOptional

Limit the number of results returned

offsetintegerOptional

Offset for pagination

countintegerOptional

Whether to return the count of results

keywordstringOptional

Search keyword for filtering orders

statusstringOptional

Filter orders by status

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
Successfully retrieved the count of orders
400
Invalid parameters
500
Server error
get
GET /backend/api/orders/order-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Export Order to PDF

get
Query parameters
orderProductIdintegerRequired

ID of the order product to be exported as a PDF

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
PDF export successful
Responsestring · binary
400
Invalid request parameters
500
Internal server error
get
GET /backend/api/orders/order-export-pdf HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>binary</object>

Track Order Product

get
Query parameters
orderProductIdintegerRequired

ID of the order product to track

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
Successfully shown the track order details
400
Invalid request parameters
500
Internal server error
get
GET /backend/api/orders/track-order-product HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get Ratings by Order Product ID

get
Query parameters
orderProductIdintegerRequired

ID of the order product to retrieve ratings for

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
Successfully retrieved the ratings for the order product
400
Invalid request parameters
500
Internal server error
get
GET /backend/api/product-store/rating-by-order HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get Order Details

get
Query parameters
orderProductIdintegerRequired

ID of the order product to retrieve details for

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
Successfully retrieved the order details
400
Invalid request parameters
500
Internal server error
get
GET /backend/api/orders/order-detail HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>
  • GETGet Order List Count
  • GETExport Order to PDF
  • GETTrack Order Product
  • GETGet Ratings by Order Product ID
  • POSTSubmit a Product Review
  • GETGet Order Details

Submit a Product Review

post
Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Body
orderProductIdstringRequiredExample: 2458
skuNamestringRequiredExample: GSKU1234-01
productIdintegerRequiredExample: 2088
reviewsstringRequiredExample: test
ratingintegerRequiredExample: 4
Responses
200
Successfully created your reviews.
400
Invalid input data
500
Internal server error
post
POST /backend/api/product-store/review HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 94

"orderProductId='2458'&skuName='GSKU1234-01'&productId=2088&reviews='test'&rating=4"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created your reviews.</message>
</object>