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. Payments

Archeived Payments

PreviousPaymentsNextEarnings

Last updated 4 months ago

Export vendor sales data

get

Exports the vendor sales data based on the provided vendor order ID.

Query parameters
vendorOrderIdintegerRequired

The ID of the vendor order for which the sales data is to be exported.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully exported vendor sales data.
400
Bad Request
404
Vendor order not found
500
Internal Server Error
get
GET /backend/api/vendor-sales/vendor-sales-export HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Vendor sales data exported successfully.</message>
	<data>data.csv</data>
</object>
  • GETGet archived payment list
  • POSTRevoke a vendor payment archive
  • GETExport vendor sales data

Get archived payment list

get

Fetches the list of archived payments with pagination.

Query parameters
limitintegerOptional

The number of results to return per page.

Default: 10
offsetintegerOptional

The starting point for the query, used for pagination.

Default: 0
currentPageintegerOptional

The current page of results.

Default: 1
countintegerOptional

Flag to indicate if the count of total results should be returned.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the archived payment list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-sales/archive-payment-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 payment list</message>
</object>

Revoke a vendor payment archive

post

This endpoint revokes a previously archived vendor payment using the archive ID.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
vendorPaymentArchiveIdintegerOptional
Responses
200
Successfully revoked the vendor payment archive.
400
Bad Request
500
Internal Server Error
post
POST /backend/api/vendor-sales/revoke-vendor-payment-archive HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 28

"vendorPaymentArchiveId=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Payment revoked successfully.</message>
</object>