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. Admin API
  3. Marketplace

Manage Settlements

PreviousManage SalesNextProduct Configuration

Last updated 3 months ago

Get order status list

get

Retrieve a complete list of order statuses.

Responses
200
Successfully retrieved the order status list
500
Internal server error
get
GET /backend/api/order-status/order-status-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete order status list</message>
	<orderStatusList>
		<statusId>1</statusId>
		<statusName>Pending</statusName>
		<description>The order is pending</description>
	</orderStatusList>
</object>

Retrieve seller list

get

This endpoint retrieves a list of vendors (sellers) based on the specified status.

Query parameters
statusintegerOptional

Filter sellers based on their status

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got seller list
400
Invalid request
500
Internal server error
get
GET /backend/api/admin-vendor HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Retrieve a list of vendor orders

get

This endpoint retrieves a list of orders placed by vendors based on the given query parameters.

Query parameters
limitintegerOptional

The number of orders to return

offsetintegerOptional

The offset of orders to retrieve

countintegerOptional

Count of orders (0 or 1)

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully got the complete order list
400
Invalid request
500
Internal server error
get
GET /backend/api/admin-vendor-order/vendor-order-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get settlement list

get

This endpoint retrieves a list of settlements with pagination options.

Query parameters
limitinteger · int32Optional

Limit the number of results returned

offsetinteger · int32Optional

Skip a certain number of records before starting the results

countinteger · int32Optional

Include count in the response to show the total number of settlements

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved settlement list
400
Bad request
500
Internal server error
get
GET /backend/api/settlement HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get settlement details by ID

get

This endpoint retrieves the details of a specific settlement by its unique identifier.

Path parameters
settlementIdinteger · int32Required

ID of the settlement to retrieve details for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Successfully retrieved settlement details
400
Bad request
404
Settlement not found
500
Internal server error
get
GET /backend/api/settlement/settlement/{settlementId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Download settlement export in Excel format

get

This endpoint allows downloading the settlement data in Excel format based on the provided settlement ID.

Query parameters
settlementIdinteger · int32Required

ID of the settlement to export in Excel format

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200
Excel file generated successfully
Responsestring · binary
400
Bad request
404
Settlement not found
500
Internal server error
get
GET /backend/api/settlement/settlement-export-excel-download HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>binary</object>
  • GETGet order status list
  • GETRetrieve seller list
  • GETRetrieve a list of vendor orders
  • GETGet settlement list
  • POSTCreate a new settlement
  • GETGet settlement details by ID
  • GETDownload settlement export in Excel format

Create a new settlement

post

This endpoint allows you to create a new settlement for a vendor order.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringRequired

Title of the settlement

vendorOrderIdinteger[]Required

List of vendor order IDs associated with the settlement

Responses
200
Successfully created new settlement
400
Invalid request
500
Internal server error
post
POST /backend/api/settlement HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 36

"title='text'&vendorOrderId=[1]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>