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

Data Export

PreviousCommon ProductNextPricing

Last updated 3 months ago

Get Vendor Export Log List

get

Fetches a paginated list of export logs.

Query parameters
limitintegerOptional

The number of records to fetch per page.

Default: 10
offsetintegerOptional

The offset for pagination.

Default: 0
currentPageintegerOptional

The current page number for pagination.

Default: 1
countintegerOptional

Flag to include count of total records (1 = include, 0 = exclude).

Default: 0
Responses
200
Successfully fetched the export log list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-export-log HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the export log list !!</message>
</object>

Get Failed Order Excel List

get

Fetches a list of failed orders in Excel format.

Query parameters
failedOrderbooleanOptional

Flag to filter for failed orders.

Default: true
orderIdstringOptional

Specific order ID to filter the results.

Responses
200
Successfully fetched the failed order Excel list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-order/failed-order-excel-list/ HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully fetched the failed order Excel list.</message>
</object>

Get Count of Failed Orders

get

Fetches the count of failed vendor orders.

Query parameters
countintegerRequired

Flag to request the count of failed orders.

Default: 1
Responses
200
Successfully fetched the count of failed orders.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-order/vendor-failed-order-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the cancel request count</message>
</object>

Export customer data

get

Exports customer data in an Excel file format.

Query parameters
failedOrderbooleanOptional

Indicates whether to include failed orders.

orderIdstringOptional

The order ID to filter the export.

Responses
200
File exported successfully.
Responsestring · binary
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-order/export-customer HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>binary</object>

Get the list of customers who purchased the product

get

Fetch the list of customers who purchased products, with optional filtering by customer ID and count.

Query parameters
countintegerOptional

The number of records to fetch.

customerIdintegerOptional

The ID of the customer to filter the list.

Responses
200
Successfully retrieved the list of customers
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-order/purchased-customer-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Seller Order List</message>
</object>

Download the complete list of all products as an Excel file

get

Fetch a list of all products in Excel format.

Query parameters
countbooleanOptional

Include the count of products in the response (optional)

Responses
200
Successfully fetched the product list in Excel format.
Responsestring · binary
400
Bad Request
500
Internal Server Error
get
GET /backend/api/vendor-product/allproduct-excel-list/ HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>binary</object>
  • GETGet Vendor Export Log List
  • GETGet Failed Order Excel List
  • POSTCreate an Export Log for Failed Orders
  • GETGet Count of Failed Orders
  • GETExport customer data
  • GETGet the list of customers who purchased the product
  • GETDownload the complete list of all products as an Excel file

Create an Export Log for Failed Orders

post

Creates a new export log for failed orders.

Body
recordAvailableinteger · int32Required

The number of records available for export.

modulestringRequired

The name of the module (e.g., 'Failed Orders').

createdByinteger · int32Required

The ID of the user creating the export log.

Responses
200
Export log created successfully.
400
Bad Request
500
Internal Server Error
post
POST /backend/api/vendor-export-log HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 51

"recordAvailable=1&module='text'&createdBy=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Export log created successfully</message>
</object>