Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
      • 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
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product List
        • Product Localisation
        • 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
      • 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 Core API
  2. Admin API

Manage Sales

Last updated 2 years ago

Order Status

order list

get

Get list of orders.

Query parameters
limitintegerRequired
offsetintegerOptional
orderIdstringRequired
orderStatusIdstringRequired
customerNamestringOptional
totalAmountstringOptional
dateAddedstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/orderlist?limit=1&orderId=text&orderStatusId=text HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

order detail

get

Get a list of order.

Query parameters
orderIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order/order-detail?orderId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

order export pdf

get

Export the order pdf.

Query parameters
orderIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order/order-export-pdf?orderId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

sales graph list

get

List of salse graph list

Query parameters
yearstringOptional
monthstringOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/sales-graph-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

transaction list

get

Order transaction list.

Query parameters
yearintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/transaction-list?year=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

total order count

get

Count of today orders.

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order/today-order-count HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

today order amount

get

Amount of today order.

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order/today-order-amount HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

order excel list

get

Get order list on excel sheet.

Query parameters
orderIdstringRequired
Header parameters
AuthorizationstringRequired
Responses
400
error response
*/*
get
GET /order/order-excel-list?orderId=text HTTP/1.1
Host: 
Authorization: text
Accept: */*
400

error response

{
  "status": 1,
  "message": "text"
}

delete order

delete

Remove the exist order.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
delete
DELETE /order/delete-order/{id} HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

Order log list.

get
Query parameters
orderIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/orderLoglist?orderId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

Update payment status.

post

Update the payment status

Query parameters
orderIdintegerRequired
paymentStatusIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
application/json
400
error response
application/json
post
POST /order/update-payment-status?orderId=1&paymentStatusId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderId": 1,
  "customerId": 1,
  "currencyId": 1,
  "shippingZoneId": 1,
  "paymentZoneId": 1,
  "shippingCountryId": 1,
  "paymentCountryId": 1,
  "invoiceNo": "text",
  "invoicePrefix": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "telephone": "text",
  "fax": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingCompany": "text",
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingCity": "text",
  "shippingPostcode": "text",
  "shippingCountry": "text",
  "shippingZone": "text",
  "shippingAddressFormat": "text",
  "shippingMethod": 1,
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentCompany": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentCity": "text",
  "paymentPostcode": "text",
  "paymentCountry": "text",
  "paymentZone": "text",
  "paymentAddressFormat": "text",
  "paymentMethod": "text",
  "comment": "text",
  "couponCode": "text",
  "discountAmount": "text",
  "amount": "text",
  "total": "text",
  "reward": "text",
  "orderStatusId": 1,
  "orderPrefixId": "text",
  "affiliateId": 1,
  "commision": 1,
  "currencyCode": "text",
  "currencyValue": "text",
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "ip": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "orderName": "text",
  "paymentType": "text",
  "paymentProcess": 1,
  "paymentDetails": "text",
  "backOrders": 1,
  "isActive": 1,
  "customerGstNo": "text"
}

order product log list

get

Get list of order product log.

Query parameters
orderProductIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/order-product-log-list?orderProductId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

order count

get

Get total count of order.

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order/order-count HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

Order cancel request list.

get

List of order cancel request.

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringRequired
statusintegerOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/order-cancel-request-list?limit=1&keyword=text HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

Update bulk order cancel request.

get

Update the bulk order cancel request

Query parameters
orderProductIdintegerOptional
cancelStatusIdstringOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order/update-bulk-order-cancel-request HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

order cancel excel list

get

Excel list of order cancel.

Query parameters
orderProductIdstringOptional
Header parameters
AuthorizationstringRequired
Responses
400
error response
*/*
get
GET /order/order-cancel-excel-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
400

error response

{
  "status": 1,
  "message": "text"
}

bulk order cancel excel list

get

Excel list of bulk order cancel.

Query parameters
statusintegerRequired
keywordstringRequired
Header parameters
AuthorizationstringRequired
Responses
400
error response
*/*
get
GET /order/bulk-order-cancel-excel-list?status=1&keyword=text HTTP/1.1
Host: 
Authorization: text
Accept: */*
400

error response

{
  "status": 1,
  "message": "text"
}

back order list

get

List of bulk order.

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order/back-order-list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

failed-order-list

get

List of failed order.

Query parameters
limitintegerRequired
offsetintegerOptional
orderIdintegerOptional
orderStatusIdstringOptional
customerNamestringOptional
totalAmountintegerOptional
dateAddedintegerOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/failed-order-list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

order count for list

get

List of order count.

Query parameters
orderIdstringOptional
orderStatusIdstringOptional
customerNamestringOptional
totalAmountstringOptional
dateAddedstringOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/order-count-for-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

product list

get

List of product.

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/product-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

sales report list

get

List of salse report.

Query parameters
limitintegerRequired
offsetintegerOptional
startDatestringOptional
endDatestringOptional
productIdstringRequired
countstringOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /order/sales-report-list?limit=1&productId=text HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "text"
}

order change status

post

Status of order changes.

Header parameters
AuthorizationstringRequired
Body
orderIdinteger · int32Required
orderStatusIdinteger · int32Required
Responses
200
success response
application/json
400
error response
application/json
post
POST /order/order-change-status HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 31

"orderId=1&orderStatusId=1"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderId": 1,
  "customerId": 1,
  "currencyId": 1,
  "shippingZoneId": 1,
  "paymentZoneId": 1,
  "shippingCountryId": 1,
  "paymentCountryId": 1,
  "invoiceNo": "text",
  "invoicePrefix": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "telephone": "text",
  "fax": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingCompany": "text",
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingCity": "text",
  "shippingPostcode": "text",
  "shippingCountry": "text",
  "shippingZone": "text",
  "shippingAddressFormat": "text",
  "shippingMethod": 1,
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentCompany": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentCity": "text",
  "paymentPostcode": "text",
  "paymentCountry": "text",
  "paymentZone": "text",
  "paymentAddressFormat": "text",
  "paymentMethod": "text",
  "comment": "text",
  "couponCode": "text",
  "discountAmount": "text",
  "amount": "text",
  "total": "text",
  "reward": "text",
  "orderStatusId": "text",
  "orderPrefixId": "text",
  "affiliateId": 1,
  "commision": "text",
  "currencyCode": "text",
  "currencyValue": 1,
  "currencySymbolLeft": "text",
  "currencySymbolRight": 1,
  "ip": "text",
  "paymentFlag": "text",
  "paymentStatus": 1,
  "trackingUrl": "text",
  "trackingNo": 1,
  "orderName": "text",
  "paymentType": 1,
  "paymentProcess": 1,
  "paymentDetails": "text",
  "backOrders": 1,
  "isActive": 1,
  "customerGstNo": "text",
  "orderLogId": 1
}

delete order

post

Delete the exist orders.

Header parameters
AuthorizationstringRequired
Body
orderIdinteger[]Optional
Responses
200
success response
application/json
400
error response
application/json
post
POST /order/delete-order HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15

"orderId=[1]"
{
  "status": 1,
  "message": "text"
}

Update shipping information.

post

Update the shipping information.

Header parameters
AuthorizationstringRequired
Body
orderIdinteger · int32Required
trackingUrlstringRequired
trackingNostringRequired
Responses
200
success response
application/json
400
error response
application/json
post
POST /order/update-shipping-information HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54

"orderId=1&trackingUrl='text'&trackingNo='text'"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderId": 1,
  "customerId": 1,
  "currencyId": 1,
  "shippingZoneId": 1,
  "paymentZoneId": 1,
  "shippingCountryId": 1,
  "paymentCountryId": 1,
  "invoiceNo": "text",
  "invoicePrefix": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "telephone": "text",
  "fax": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingCompany": "text",
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingCity": "text",
  "shippingPostcode": "text",
  "shippingCountry": "text",
  "shippingZone": "text",
  "shippingAddressFormat": "text",
  "shippingMethod": 1,
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentCompany": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentCity": "text",
  "paymentPostcode": "text",
  "paymentCountry": "text",
  "paymentZone": "text",
  "paymentAddressFormat": "text",
  "paymentMethod": "text",
  "comment": "text",
  "couponCode": "text",
  "discountAmount": "text",
  "amount": "text",
  "total": "text",
  "reward": "text",
  "orderStatusId": 1,
  "orderPrefixId": "text",
  "affiliateId": 1,
  "commision": "text",
  "currencyCode": "text",
  "currencyValue": "text",
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "ip": "text",
  "paymentFlag": 1,
  "paymentStatus": 1,
  "trackingUrl": "text",
  "trackingNo": "text",
  "orderName": "text",
  "paymentType": "text",
  "paymentProcess": 1,
  "paymentDetails": "text",
  "backOrders": 1,
  "isActive": 1,
  "customerGstNo": "text"
}

Update order product shipping information.

post

Update the order product shipping information

Header parameters
AuthorizationstringRequired
Body
orderProductIdinteger · int32Required
trackingUrlstringRequired
trackingNostringRequired
Responses
200
success response
application/json
400
error response
application/json
post
POST /order/update-order-product-shipping-information HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 61

"orderProductId=1&trackingUrl='text'&trackingNo='text'"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderProductId": 1,
  "productId": 1,
  "orderProductPrefixId": "text",
  "orderId": 1,
  "name": "text",
  "model": "text",
  "quantity": 1,
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "taxType": 1,
  "taxValue": 1,
  "total": "text",
  "discountedAmount": 1,
  "orderStatusId": 1,
  "trackingUrl": "text",
  "trackingNo": "text",
  "trace": "text",
  "tax": "text",
  "cancelRequest": 1,
  "cancelRequestStatus": 1,
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "isActive": 1,
  "skuName": "text",
  "couponDiscountAmount": 1
}

Update-order-product-status.

put

Update the order product status

Path parameters
orderProductIdintegerRequired
Header parameters
AuthorizationstringRequired
Body
orderStatusIdinteger · int32Optional
Responses
200
success response
application/json
400
error response
application/json
put
PUT /order/update-order-product-status/{orderProductId} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 19

"orderStatusId=1"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderProductId": 1,
  "productId": 1,
  "orderProductPrefixId": "text",
  "orderId": 1,
  "name": "text",
  "model": "text",
  "quantity": 1,
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "taxType": 1,
  "taxValue": 1,
  "total": "text",
  "discountedAmount": "text",
  "orderStatusId": 1,
  "trackingUrl": "text",
  "trackingNo": "text",
  "trace": "text",
  "tax": "text",
  "cancelRequest": 1,
  "cancelRequestStatus": 1,
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "isActive": 1,
  "skuName": "text",
  "couponDiscountAmount": 1
}

Update order cancel request.

put

Update the order cancel request.

Path parameters
orderProductIdintegerRequired
Header parameters
AuthorizationstringRequired
Body
cancelStatusIdinteger · int32Required
Responses
200
success response
application/json
400
error response
application/json
put
PUT /order/update-order-cancel-request/{orderProductId} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"cancelStatusId=1"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderProductId": 1,
  "productId": 1,
  "orderProductPrefixId": "text",
  "orderId": 1,
  "name": "text",
  "model": "text",
  "quantity": 1,
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "taxType": 1,
  "taxValue": 1,
  "total": "text",
  "discountedAmount": 1,
  "orderStatusId": 1,
  "trackingUrl": "text",
  "trackingNo": "text",
  "trace": "text",
  "tax": 1,
  "cancelRequest": 1,
  "cancelRequestStatus": 1,
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "isActive": 1,
  "skuName": "text",
  "couponDiscountAmount": 1
}

update main order

post

Update the main order.

Header parameters
AuthorizationstringRequired
Body
orderIdinteger · int32Required
paymentMethodstringRequired
paymentRefIdstringRequired
paymentStatusinteger · int32Required
paymentDetailstringOptional
Responses
200
success response
application/json
400
error response
application/json
post
POST /order/update-main-order HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 99

"orderId=1&paymentMethod='text'&paymentRefId='text'&paymentStatus=1&paymentDetail='text'"
{
  "status": 1,
  "message": "text"
}

order-fullfillment-status-list

get

Get list of order fullfillment status.

Query parameters
limitintegerRequired
offsetintegerOptional
countstringOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order-status/order-fullfillment-status-list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

order status list based on parent

get

Get the order status list based on parent.

Query parameters
limitstringRequired
offsetintegerOptional
parentIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order-status/order-status-list-based-on-parent?limit=text&parentId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

order-status-list

get

Get list of order status.

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
statusstringOptional
countstringOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /order-status/order-status-list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}

delete order status

delete

Delete a order status.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
delete
DELETE /order-status/delete-order-status/{id} HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "text"
}
  • GETorder list
  • GETorder detail
  • GETorder export pdf
  • GETsales graph list
  • GETtransaction list
  • GETtotal order count
  • GETtoday order amount
  • POSTorder change status
  • GETorder excel list
  • DELETEdelete order
  • POSTdelete order
  • GETOrder log list.
  • POSTUpdate payment status.
  • POSTUpdate shipping information.
  • POSTUpdate order product shipping information.
  • PUTUpdate-order-product-status.
  • GETorder product log list
  • GETorder count
  • GETOrder cancel request list.
  • PUTUpdate order cancel request.
  • GETUpdate bulk order cancel request.
  • GETorder cancel excel list
  • GETbulk order cancel excel list
  • GETback order list
  • GETfailed-order-list
  • POSTupdate main order
  • GETorder count for list
  • GETproduct list
  • GETsales report list
  • Order Status
  • POSTcreate order status
  • PUTupdate order status
  • PUTupdate order fullfillment status
  • GETorder-fullfillment-status-list
  • GETorder status list based on parent
  • GETorder-status-list
  • DELETEdelete order status

create order status

post

Add a category order status.

Header parameters
AuthorizationstringRequired
Body
namestringRequired
colorCodestringRequired
priorityinteger · int32Optional
statusinteger · int32Required
parentIdinteger · int32Optional
isAdmininteger · int32Optional
isVendorinteger · int32Optional
isBuyerinteger · int32Optional
isApiinteger · int32Optional
Responses
200
success response
application/json
400
error response
application/json
post
POST /order-status/create-order-status HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 118

"name='text'&colorCode='text'&priority=1&status=1&parentId=1&isAdmin=1&isVendor=1&isBuyer=1&isApi=1"
{
  "name": "text",
  "colorCode": "text",
  "priority": 1,
  "isActive": "text",
  "parentId": "text",
  "createdDate": "text",
  "orderStatusId": 1
}

update order status

put

Update a category order status.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
namestringRequired
colorCodestringRequired
priorityinteger · int32Optional
statusinteger · int32Required
parentIdinteger · int32Optional
isAdmininteger · int32Optional
isVendorinteger · int32Optional
isBuyerinteger · int32Optional
isApiinteger · int32Optional
Responses
200
success response
application/json
400
error response
application/json
put
PUT /order-status/update-order-status/{id} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 118

"name='text'&colorCode='text'&priority=1&status=1&parentId=1&isAdmin=1&isVendor=1&isBuyer=1&isApi=1"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderStatusId": 1,
  "name": "text",
  "isActive": "text",
  "priority": "text",
  "parentId": 1,
  "defaultStatus": 1,
  "colorCode": "text"
}

update order fullfillment status

put

Get list of the category order status.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
statusinteger · int32Optional
Responses
200
success response
application/json
400
error response
application/json
put
PUT /order-status/update-order-fullfillment-status/{id} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 12

"status=1"
{
  "createdBy": 1,
  "createdDate": "2025-05-09T08:02:19.113Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-05-09T08:02:19.113Z",
  "orderStatusId": 1,
  "name": "text",
  "isActive": 1,
  "priority": 1,
  "parentId": 1,
  "defaultStatus": 1,
  "isAdmin": 1,
  "isVendor": 1,
  "isBuyer": 1,
  "isApi": 1,
  "colorCode": "text"
}