Marketplace

Get seller product list

get

/admin-vendor-product

Retrieves a list of products associated with sellers.

Query parameters

limitintegerOptional

Number of products to return per page.

offsetintegerOptional

Pagination offset for product retrieval.

countintegerOptional

Include total count (0 = no, 1 = yes).

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved seller product list

*/*

statusintegerOptional

messagestringOptional

400

Invalid request parameters

*/*

get

/admin-vendor-product

GET /backend/api/admin-vendor-product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Approve or reject a seller product

put

/admin-vendor-product/approve-product/{id}

Approves or rejects a product based on provided parameters.

Path parameters

idintegerRequired

Product ID to approve or reject.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

productIdsintegerRequired

Product ID being processed.

approvalFlagstringRequired

Approval status (e.g., '1' for approved, '2' for rejected).

reasonstringRequired

Reason for rejection, if applicable.

Responses

200

Product approval/rejection successful

*/*

statusintegerOptional

messagestringOptional

400

Invalid input data

*/*

put

/admin-vendor-product/approve-product/{id}

PUT /backend/api/admin-vendor-product/approve-product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 54

{
  "productIds": 1,
  "approvalFlag": "text",
  "reason": "text"
}

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

Update product status

put

/admin-vendor-product/add-product-status/{id}

Updates the status of a vendor product.

Path parameters

idintegerRequired

Product ID for which the status is to be updated.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

statusintegerRequired

New status of the product (0 for inactive, 1 for active).

idintegerRequired

ID of the product being updated.

Responses

200

Status update successful

*/*

statusintegerOptional

messagestringOptional

400

Invalid input data

*/*

put

/admin-vendor-product/add-product-status/{id}

PUT /backend/api/admin-vendor-product/add-product-status/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 19

{
  "status": 1,
  "id": 1
}

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

Generate Excel for vendor product

post

/admin-vendor-product/vendor-product-excel-list

Generates an Excel list for the provided product ID.

Query parameters

productIdintegerRequired

Product ID for which the Excel list will be generated.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

productIdstringRequired

Product ID as a string input.

Responses

200

Excel list generated successfully

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully generated Excel list

400

Invalid product ID provided

*/*

post

/admin-vendor-product/vendor-product-excel-list

POST /backend/api/admin-vendor-product/vendor-product-excel-list?productId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 20

{
  "productId": "text"
}

{
  "status": 1,
  "message": "Successfully generated Excel list"
}

Get common catalog products

get

/admin-common-product

Fetch a list of common catalog products with pagination and filtering options.

Query parameters

limitintegerOptional

Number of products to retrieve per page.

offsetintegerOptional

Number of products to skip before starting to fetch the results.

countintegerOptional

Flag to include total product count (1 for yes, 0 for no).

ownerintegerOptional

Filter products by owner ID.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Common catalog product list retrieved successfully

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the common catalog product list

400

Invalid request parameters

*/*

get

/admin-common-product

GET /backend/api/admin-common-product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the common catalog product list"
}

Set product as common

put

/admin-common-product/{id}

Update a product to mark it as common.

Path parameters

idintegerRequired

The ID of the product to be updated.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

commonIdintegerOptionalExample: 2125

commonintegerOptional

Flag to set product as common (1 for common, 0 for not common)

Example: 1

Responses

200

Successfully updated product as common

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully set as common product

400

Invalid request or missing parameters

*/*

put

/admin-common-product/{id}

PUT /backend/api/admin-common-product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 28

{
  "commonId": 2125,
  "common": 1
}

{
  "status": 1,
  "message": "Successfully set as common product"
}

Get vendor category list

get

/category

Retrieve a list of vendor categories with filtering and pagination options.

Query parameters

limitintegerOptional

Number of categories to retrieve.

offsetintegerOptional

The number of categories to skip for pagination.

keywordstringOptional

Keyword to filter categories by name.

sortOrderintegerOptional

Sort order (e.g., 0 for ascending, 1 for descending).

statusintegerOptional

Filter categories by status (active or inactive).

namestringOptional

Name of the category to filter by.

industryIdintegerOptional

Filter categories by industry ID.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved category list

*/*

statusintegerOptional

messagestringOptional

get

/category

GET /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully retrieved category list

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

Create a new category

post

/category

Create a new category with the provided details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

namestringRequiredExample: test

sortOrderintegerRequiredExample: 1

metaTagDescriptionstringOptional

metaTagKeywordstringOptional

metaTagTitlestringOptional

parentIntintegerRequiredExample: 1424

imagestringOptional

imagePathstringOptional

statusstringRequiredExample: 1

categorySlugstringRequiredExample: test

categoryDescriptionstringRequiredExample: <p>test</p>

industryIdintegerRequiredExample: 1

Responses

200

Successfully created the new category.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully created New Category.

400

Invalid input or missing required fields.

500

Internal server error.

post

/category

POST /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 220

{
  "name": "test",
  "sortOrder": 1,
  "metaTagDescription": "",
  "metaTagKeyword": "",
  "metaTagTitle": "",
  "parentInt": 1424,
  "image": "",
  "imagePath": "",
  "status": "1",
  "categorySlug": "test",
  "categoryDescription": "<p>test</p>",
  "industryId": 1
}

{
  "status": 1,
  "message": "Successfully created New Category."
}

Get a list of industries

get

/list/industry

Retrieve a list of industries with optional filters.

Query parameters

limitintegerOptional

The number of industries to return per page (optional).

offsetintegerOptional

The offset for the list of industries (optional).

keywordstringOptional

A search keyword to filter the industries by name (optional).

sortOrderstring · enumOptional

The sorting order of the results (optional).

Possible values:

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully got the industry list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got industry list

400

Invalid parameters

500

Internal server error

get

/list/industry

GET /backend/api/list/industry HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got industry list"
}

Get category translation list

get

/category/category-translation

Retrieve a list of category translations with optional filters.

Query parameters

offsetintegerOptional

The offset for pagination.

limitintegerOptional

The number of translations to return per page.

keywordstringOptional

A search keyword to filter the category translations by name.

skustringOptional

A filter for the category translations by SKU.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved category translation list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got category translation list

400

Invalid parameters

500

Internal server error

get

/category/category-translation

GET /backend/api/category/category-translation HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got category translation list"
}

Get category translation detail

get

/category/{categoryId}/category-translation

Retrieve the translation details for a specific category based on the category ID.

Path parameters

categoryIdintegerRequired

ID of the category to retrieve the translation for

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved category translation detail

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully Got Category Translation Detail

400

Invalid category ID

404

Category translation not found

500

Internal server error

get

/category/{categoryId}/category-translation

GET /backend/api/category/{categoryId}/category-translation HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully Got Category Translation Detail"
}

Save category translations

post

/category/{categoryId}/category-translation

Save translations for a specific category based on the category ID.

Path parameters

categoryIdintegerRequired

ID of the category to save translations for

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

Responses

200

Successfully saved category translations

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully Saved Category Translation

400

Invalid input

500

Internal server error

post

/category/{categoryId}/category-translation

POST /backend/api/category/{categoryId}/category-translation HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 84

{
  "categoryTranslation": [
    {
      "languageId": 1,
      "name": "text",
      "description": "text",
      "id": 1
    }
  ]
}

{
  "status": 1,
  "message": "Successfully Saved Category Translation"
}

Update category

put

/category/{categoryId}

Update an existing category with new details.

Path parameters

categoryIdintegerRequired

ID of the category to be updated

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

categoryIdstringRequired

namestringRequired

sortOrderintegerRequired

metaTagDescriptionstringOptional

metaTagKeywordstringOptional

metaTagTitlestringOptional

parentIntintegerOptional

imagestringOptional

statusstringRequired

categorySlugstringRequired

categoryDescriptionstringOptional

industryIdintegerRequired

Responses

200

Successfully updated category

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully updated category

400

Invalid input data

404

Category not found

500

Internal server error

put

/category/{categoryId}

PUT /backend/api/category/{categoryId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 234

{
  "categoryId": "text",
  "name": "text",
  "sortOrder": 1,
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "metaTagTitle": "text",
  "parentInt": 1,
  "image": "text",
  "status": "text",
  "categorySlug": "text",
  "categoryDescription": "text",
  "industryId": 1
}

{
  "status": 1,
  "message": "Successfully updated category"
}

Delete category

delete

/category/{categoryId}

Delete an existing category by its ID.

Path parameters

categoryIdintegerRequired

ID of the category to be deleted

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted category

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully deleted category

400

Invalid category ID

404

Category not found

500

Internal server error

delete

/category/{categoryId}

DELETE /backend/api/category/{categoryId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted category"
}

Get export log list

get

/export-log

Retrieve a paginated list of export logs.

Query parameters

limitintegerOptional

Number of records to retrieve

Default: 10

offsetintegerOptional

Number of records to skip

Default: 0

countintegerOptional

Flag to indicate if the count should be returned (1 for true, 0 for false)

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved export log list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the export log list

400

Invalid query parameters

500

Internal server error

get

/export-log

GET /backend/api/export-log HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the export log list"
}

Get order Excel list

get

/order/order-excel-list/

Retrieve a list of orders in Excel format, with an optional filter for failed orders.

Query parameters

failedOrderbooleanOptional

Filter orders by failed status (true or false)

Default: false

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved order Excel list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully retrieved order Excel list

400

Invalid query parameters

500

Internal server error

get

/order/order-excel-list/

GET /backend/api/order/order-excel-list/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully retrieved order Excel list"
}

Get QR code product list

get

/qrCode/product-list

Retrieve a paginated list of products linked with QR codes.

Query parameters

limitintegerOptional

Number of records to retrieve

Default: 10

offsetintegerOptional

Number of records to skip

Default: 0

countintegerOptional

Flag to indicate if the count should be returned (1 for true, 0 for false)

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved QR code product list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the complete product list.

400

Invalid query parameters

500

Internal server error

get

/qrCode/product-list

GET /backend/api/qrCode/product-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete product list."
}

Get website settings

get

/settings

Retrieve website settings based on query parameters.

Query parameters

defaultWebsiteintegerOptional

Specify whether to retrieve the default website settings (1 for true, 0 for false).

Default: 1

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved website settings

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got settings

400

Invalid query parameters

500

Internal server error

get

/settings

GET /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got settings"
}

Generate QR code for products

post

/qrCode/created-qrcode

Generate QR codes based on the provided product data.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

Responses

200

Successfully generated the product QR code

application/json

statusintegerOptionalExample: 1

messagestringOptionalExample: successfully generated the product qr-code !!

400

Invalid request data

500

Internal server error

post

/qrCode/created-qrcode

POST /backend/api/qrCode/created-qrcode HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "productData": [
    {
      "productId": 2124,
      "productSlug": "urban-platter-sauerkraut-original-pickled2",
      "base64Image": ""
    }
  ]
}

{
  "status": 1,
  "message": "successfully generated the product qr-code !!"
}

Download QR code image

get

/qrCode/download-qrimage/{productId}

Retrieve the QR code image for a given product ID.

Path parameters

productIdintegerRequired

The ID of the product whose QR code image needs to be downloaded

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved QR code image

string · binaryOptional

400

Invalid product ID

404

QR code not found for the given product ID

500

Internal server error

get

/qrCode/download-qrimage/{productId}

GET /backend/api/qrCode/download-qrimage/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

binary

Get vendor orders

get

/admin-vendor-order

Retrieve a list of vendor orders with optional query parameters.

Query parameters

limitintegerOptional

The number of orders to retrieve

offsetintegerOptional

The number of orders to skip before starting to collect the result set

countintegerOptional

Include the count of total records (1 for true, 0 for false)

keyUpbooleanOptional

Boolean flag to filter orders

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the vendor order list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the complete order list

400

Invalid query parameters

500

Internal server error

get

/admin-vendor-order

GET /backend/api/admin-vendor-order HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete order list"
}

Get order detail

get

/admin-vendor-order/order-detail

Retrieve detailed information for a specific vendor order using the provided orderId.

Query parameters

orderIdintegerRequired

The ID of the order to retrieve details for

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved order details

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully shown the order detail

400

Invalid orderId parameter

404

Order not found

500

Internal server error

get

/admin-vendor-order/order-detail

GET /backend/api/admin-vendor-order/order-detail?orderId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully shown the order detail",
  "orderDetail": {
    "orderId": 1628,
    "vendorName": "Vendor A",
    "orderStatus": "Completed",
    "orderDate": "2024-01-01T12:00:00Z",
    "totalAmount": 200.5,
    "items": [
      {
        "itemId": 101,
        "itemName": "Product A",
        "quantity": 2,
        "price": 50.25
      }
    ]
  }
}

Get vendor order status log list

get

/admin-vendor-order/vendor-order-log-list

Retrieve the order status log for a specific vendor order using the provided vendorOrderId.

Query parameters

vendorOrderIdintegerRequired

The ID of the vendor order to retrieve the log list for

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the vendor order log list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the complete seller order status log list

400

Invalid vendorOrderId parameter

404

Vendor order not found

500

Internal server error

get

/admin-vendor-order/vendor-order-log-list

GET /backend/api/admin-vendor-order/vendor-order-log-list?vendorOrderId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete seller order status log list",
  "logList": [
    {
      "logId": 5001,
      "status": "Shipped",
      "date": "2024-01-15T14:00:00Z",
      "description": "Order has been shipped to the vendor"
    }
  ]
}

Get order status list

get

/order-status/order-status-list

Retrieve a complete list of order statuses.

Responses

200

Successfully retrieved the order status list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the complete order status list

500

Internal server error

get

/order-status/order-status-list

GET /backend/api/order-status/order-status-list HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete order status list",
  "orderStatusList": [
    {
      "statusId": 1,
      "statusName": "Pending",
      "description": "The order is pending"
    }
  ]
}

Export vendor order details as PDF

get

/admin-vendor-order/order-export-pdf

Exports the details of a specific vendor order as a PDF file using the orderId, vendorId, and orderPrefixId.

Query parameters

orderIdintegerRequired

The ID of the order to be exported

vendorIdintegerRequired

The ID of the vendor associated with the order

orderPrefixIdstringRequired

The prefix ID of the order, typically for identifying the order uniquely

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully exported the order details as a PDF

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully exported the order as a PDF

pdfUrlstringOptionalExample: http://139.59.67.17/backend/api/downloads/order-1628.pdf

400

Invalid query parameters

404

Order not found

500

Internal server error

get

/admin-vendor-order/order-export-pdf

GET /backend/api/admin-vendor-order/order-export-pdf?orderId=1&vendorId=1&orderPrefixId=text HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully exported the order as a PDF",
  "pdfUrl": "http://139.59.67.17/backend/api/downloads/order-1628.pdf"
}

Update payment status of an order

post

/order/update-payment-status

Updates the payment status for a specific order using the orderId and paymentStatusId.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

orderIdstringOptionalExample: 1628

paymentStatusIdintegerOptionalExample: 1

Responses

200

Successfully updated the payment status

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully updated the Payment Status

400

Invalid request payload

404

Order not found

500

Internal server error

post

/order/update-payment-status

POST /backend/api/order/update-payment-status HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 38

{
  "orderId": "1628",
  "paymentStatusId": 1
}

{
  "status": 1,
  "message": "Successfully updated the Payment Status"
}

Get back order list

get

/order/back-order-list

Retrieves the list of back orders, with options for pagination.

Query parameters

limitintegerOptional

The number of items to return per page

Default: 10

offsetintegerOptional

The offset for pagination

Default: 0

countintegerOptional

A flag to count the total number of back orders

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the back order list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully shown the Back Order list

400

Invalid query parameter

500

Internal server error

get

/order/back-order-list

GET /backend/api/order/back-order-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully shown the Back Order list"
}

Get failed order list

get

/order/failed-order-list

Retrieves the list of failed orders, with options for pagination.

Query parameters

limitintegerOptional

The number of items to return per page

Default: 10

offsetintegerOptional

The offset for pagination

Default: 0

countintegerOptional

A flag to count the total number of failed orders

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the failed order list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the failed order list

400

Invalid query parameter

500

Internal server error

get

/order/failed-order-list

GET /backend/api/order/failed-order-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the failed order list"
}

Get order details

get

/order/order-detail

Retrieves the details of a specific order by its ID.

Query parameters

orderIdintegerRequired

The ID of the order to retrieve details for

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the order details

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully shown the order detail

400

Invalid order ID

500

Internal server error

get

/order/order-detail

GET /backend/api/order/order-detail?orderId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully shown the order detail"
}

Update main order payment details

post

/order/update-main-order

This API updates the main order's payment status and related details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

orderIdintegerRequiredExample: 1619

paymentStatusintegerRequiredExample: 2

paymentMethodintegerRequiredExample: 1

paymentRefIdstringRequiredExample: 2432345

paymentDetailstringRequiredExample: ds

Responses

200

Successfully updated the order

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully updated your order

400

Invalid request data

500

Internal server error

post

/order/update-main-order

POST /backend/api/order/update-main-order HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 98

{
  "orderId": 1619,
  "paymentStatus": 2,
  "paymentMethod": 1,
  "paymentRefId": "2432345",
  "paymentDetail": "ds"
}

{
  "status": 1,
  "message": "Successfully updated your order"
}

Get payment list

get

/admin-vendor-payment/payment-list

Retrieves a list of payments based on optional filters such as customer name, keyword, and date range.

Query parameters

limitintegerOptional

The number of results to return

offsetintegerOptional

The offset from which to start retrieving the results

countintegerOptional

Whether to return the total count of items (0 or 1)

customerNamestringOptional

The name of the customer to filter the payments by

keywordstringOptional

A keyword to filter the payments by (e.g., order ID, payment reference)

startDatestring · dateOptional

The start date for filtering payments

endDatestring · dateOptional

The end date for filtering payments

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the payment list

*/*

statusintegerOptional

messagestringOptional

400

Invalid parameters

500

Internal server error

get

/admin-vendor-payment/payment-list

GET /backend/api/admin-vendor-payment/payment-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get live cart list or count

get

/admin-cart

Retrieves the list of live carts or the count based on the provided filters.

Query parameters

limitintegerOptional

The number of results to return

offsetintegerOptional

The offset from which to start retrieving the results

countintegerOptional

Whether to return the total count of items (0 or 1)

typestringOptional

The type of cart (e.g., 'live')

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the live cart list or count

*/*

statusintegerOptional

messagestringOptional

400

Invalid parameters

500

Internal server error

get

/admin-cart

GET /backend/api/admin-cart HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get cart details by ID

get

/admin-cart/{cartId}

Retrieves the details of a specific cart by ID.

Path parameters

cartIdintegerRequired

The ID of the cart to retrieve

Query parameters

typestringOptional

The type of cart (e.g., 'live')

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the cart details

*/*

statusintegerOptional

messagestringOptional

400

Invalid cart ID or parameters

500

Internal server error

get

/admin-cart/{cartId}

GET /backend/api/admin-cart/{cartId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Send email for abandoned cart

post

/admin-cart/abandoned-cart-email

Sends an email notification to the customer regarding their abandoned cart.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

idintegerRequired

The ID of the abandoned cart

messagestringRequired

The custom message to be sent with the email

Responses

200

Successfully sent the email

*/*

statusintegerOptional

messagestringOptional

400

Invalid request parameters

500

Internal server error

post

/admin-cart/abandoned-cart-email

POST /backend/api/admin-cart/abandoned-cart-email HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 25

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

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

Export cart data

post

/admin-cart/cart-export

Exports the cart details for a given customer.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

customerIdstringRequired

The ID of the customer whose cart needs to be exported.

Responses

200

Successfully exported cart data

*/*

statusintegerOptional

messagestringOptional

400

Invalid request parameters

500

Internal server error

post

/admin-cart/cart-export

POST /backend/api/admin-cart/cart-export HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 21

{
  "customerId": "text"
}

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

Delete abandoned cart list

put

/admin-cart/abandoned

Deletes abandoned cart entries for specific customers based on customerId and guestIp.

Query parameters

actionstringRequired

The action to be performed (e.g., delete).

customerIdstringRequired

Comma-separated list of customer IDs for whom the abandoned cart details should be deleted.

guestIpstringRequired

Comma-separated list of guest IP addresses for whom the abandoned cart details should be deleted.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted cart list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully Deleted Cart List...!

400

Invalid request parameters

500

Internal server error

put

/admin-cart/abandoned

PUT /backend/api/admin-cart/abandoned?action=text&customerId=text&guestIp=text HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully Deleted Cart List...!"
}

Retrieve seller list

get

/admin-vendor

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

application/json

statusintegerOptional

messagestringOptional

400

Invalid request

500

Internal server error

get

/admin-vendor

GET /backend/api/admin-vendor HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Retrieve a list of vendor orders

get

/admin-vendor-order/vendor-order-list

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

application/json

statusintegerOptional

messagestringOptional

400

Invalid request

500

Internal server error

get

/admin-vendor-order/vendor-order-list

GET /backend/api/admin-vendor-order/vendor-order-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get settlement list

get

/settlement

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

application/json

statusintegerOptional

Status code indicating success

messagestringOptional

Success message

400

Bad request

500

Internal server error

get

/settlement

GET /backend/api/settlement HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Create a new settlement

post

/settlement

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

application/json

statusintegerOptional

messagestringOptional

400

Invalid request

500

Internal server error

post

/settlement

POST /backend/api/settlement HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 36

{
  "title": "text",
  "vendorOrderId": [
    1
  ]
}

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

Get settlement details by ID

get

/settlement/settlement/{settlementId}

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

application/json

statusintegerOptional

Status code indicating success

messagestringOptional

Success message

400

Bad request

404

Settlement not found

500

Internal server error

get

/settlement/settlement/{settlementId}

GET /backend/api/settlement/settlement/{settlementId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Download settlement export in Excel format

get

/settlement/settlement-export-excel-download

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

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string · binaryOptional

400

Bad request

404

Settlement not found

500

Internal server error

get

/settlement/settlement-export-excel-download

GET /backend/api/settlement/settlement-export-excel-download?settlementId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

binary

Retrieve product list with filters

get

/order/product-list

This endpoint allows fetching the product list with various filters like keyword, SKU, status, and price.

Query parameters

offsetinteger · int32Required

The offset for pagination, indicates the starting point of the list.

limitinteger · int32Required

The number of products to return in the response.

keywordstringOptional

Search keyword to filter products by name or other attributes.

skustringOptional

Filter products by SKU (Stock Keeping Unit).

statusstringOptional

Filter products by status (e.g., active or inactive).

priceinteger · int32Optional

Filter products by price.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved product list

*/*

idinteger · int32Optional

namestringOptional

skustringOptional

statusstringOptional

pricenumber · floatOptional

400

Bad request

500

Internal server error

get

/order/product-list

GET /backend/api/order/product-list?offset=1&limit=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "sku": "text",
    "status": "text",
    "price": 1
  }
]

Retrieve sales report list for a product within a date range

get

/order/sales-report-list

This endpoint allows fetching the sales report for a specific product between a start and end date.

Query parameters

productIdinteger · int32Required

The ID of the product for which the sales report is to be fetched.

startDatestring · dateRequired

The start date for the sales report in YYYY-MM-DD format.

endDatestring · dateRequired

The end date for the sales report in YYYY-MM-DD format.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved sales report list

*/*

productIdinteger · int32Optional

totalSalesnumber · floatOptional

totalRevenuenumber · floatOptional

datestring · dateOptional

400

Bad request

500

Internal server error

get

/order/sales-report-list

GET /backend/api/order/sales-report-list?productId=1&startDate=2026-05-14&endDate=2026-05-14 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

[
  {
    "productId": 1,
    "totalSales": 1,
    "totalRevenue": 1,
    "date": "2026-05-14"
  }
]

Retrieve total seller sales list within a specified date and amount range

get

/settlement/total-sales-report-list

This endpoint fetches the total seller sales list based on the provided date range and sales amount range.

Query parameters

startDatestring · dateRequired

The start date for the report in YYYY-MM-DD format.

endDatestring · dateRequired

The end date for the report in YYYY-MM-DD format.

amountFromnumber · floatRequired

The minimum sales amount for the report.

amountTonumber · floatRequired

The maximum sales amount for the report.

limitintegerOptional

The number of results to retrieve.

Default: 0

offsetintegerOptional

The offset for the pagination.

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved total seller sales report list

*/*

sellerIdinteger · int32Optional

totalSalesAmountnumber · floatOptional

totalSalesCountinteger · int32Optional

startDatestring · dateOptional

endDatestring · dateOptional

400

Bad request

500

Internal server error

get

/settlement/total-sales-report-list

GET /backend/api/settlement/total-sales-report-list?startDate=2026-05-14&endDate=2026-05-14&amountFrom=1&amountTo=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

[
  {
    "sellerId": 1,
    "totalSalesAmount": 1,
    "totalSalesCount": 1,
    "startDate": "2026-05-14",
    "endDate": "2026-05-14"
  }
]

Retrieve total seller sales report in Excel format within a specified date and amount range

get

/settlement/total-sales-report-excel

This endpoint fetches the total seller sales report in Excel format based on the provided date range and sales amount range.

Query parameters

startDatestring · dateRequired

The start date for the report in YYYY-MM-DD format.

endDatestring · dateRequired

The end date for the report in YYYY-MM-DD format.

amountFromnumber · floatRequired

The minimum sales amount for the report.

amountTonumber · floatRequired

The maximum sales amount for the report.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved total seller sales report in Excel format

*/*

string · binaryOptional

400

Bad request

500

Internal server error

get

/settlement/total-sales-report-excel

GET /backend/api/settlement/total-sales-report-excel?startDate=2026-05-14&endDate=2026-05-14&amountFrom=1&amountTo=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

binary

Retrieve vendor sales report list

get

/settlement/vendor-sales-report-list

This endpoint retrieves a list of vendor sales reports. It supports optional filtering by date range, vendor ID, and other parameters.

Query parameters

limitintegerOptional

Number of items per page (optional).

Default: 0

offsetintegerOptional

Pagination offset (optional).

Default: 0

startDatestring · dateOptional

Start date of the report period (optional).

endDatestring · dateOptional

End date of the report period (optional).

allVendorinteger · enumOptional

Flag to specify if the report should include all vendors or just selected ones. (0 = No, 1 = Yes)

Default: 0Possible values:

vendorsIdstringOptional

Comma-separated list of vendor IDs to filter the sales report (optional).

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the vendor sales report list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got seller list

400

Bad request

500

Internal server error

get

/settlement/vendor-sales-report-list

GET /backend/api/settlement/vendor-sales-report-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got seller list"
}

Get settlement report list

get

/settlement/settlement-report-list

Fetches the settlement report list based on the given filters.

Query parameters

limitintegerOptional

Limit the number of records returned

offsetintegerOptional

Offset the records for pagination

startDatestring · dateOptional

Start date for the report filter

endDatestring · dateOptional

End date for the report filter

allVendorinteger · enumOptional

Include all vendors (1) or not (0)

Possible values:

vendorsIdinteger[]Optional

List of vendor IDs to filter by

orderStatusintegerOptional

Filter by order status

settlementFlaginteger · enumOptional

Filter by settlement flag (0 or 1)

Possible values:

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved settlement report list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got settlement report list

400

Bad request, invalid parameters

500

Internal server error

get

/settlement/settlement-report-list

GET /backend/api/settlement/settlement-report-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got settlement report list"
}

Get settlement report in Excel format

get

/settlement/settlement-report-excel

Fetches the settlement report in Excel format based on the given filters.

Query parameters

limitintegerOptional

Limit the number of records returned

offsetintegerOptional

Offset the records for pagination

startDatestring · dateRequired

Start date for the report filter

endDatestring · dateRequired

End date for the report filter

vendorsIdinteger[]Required

List of vendor IDs to filter by

orderStatusinteger[]Optional

List of order statuses to filter by

settlementFlaginteger · enumOptional

Filter by settlement flag (0 or 1)

Possible values:

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved settlement report in Excel format

*/*

string · binaryOptional

Excel file containing the settlement report data

400

Bad request, invalid parameters

500

Internal server error

get

/settlement/settlement-report-excel

GET /backend/api/settlement/settlement-report-excel?startDate=2026-05-14&endDate=2026-05-14&vendorsId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

binary

Last updated 1 year ago

hashtagGet seller product list

hashtagApprove or reject a seller product

hashtagUpdate product status

hashtagGenerate Excel for vendor product

hashtagGet common catalog products

hashtagSet product as common

hashtagGet vendor category list

hashtagCreate a new category

hashtagGet a list of industries

hashtagGet category translation list

hashtagGet category translation detail

hashtagSave category translations

hashtagUpdate category

hashtagDelete category

hashtagGet export log list

hashtagGet order Excel list

hashtagGet QR code product list

hashtagGet website settings

hashtagGenerate QR code for products

hashtagDownload QR code image

hashtagGet vendor orders

hashtagGet order detail

hashtagGet vendor order status log list

hashtagGet order status list

hashtagExport vendor order details as PDF

hashtagUpdate payment status of an order

hashtagGet back order list

hashtagGet failed order list

hashtagGet order details

hashtagUpdate main order payment details

hashtagGet payment list

hashtagGet live cart list or count

hashtagGet cart details by ID

hashtagSend email for abandoned cart

hashtagExport cart data

hashtagDelete abandoned cart list

hashtagRetrieve seller list

hashtagRetrieve a list of vendor orders

hashtagGet settlement list

hashtagCreate a new settlement

hashtagGet settlement details by ID

hashtagDownload settlement export in Excel format

hashtagRetrieve product list with filters

hashtagRetrieve sales report list for a product within a date range

hashtagRetrieve total seller sales list within a specified date and amount range

hashtagRetrieve total seller sales report in Excel format within a specified date and amount range

hashtagRetrieve vendor sales report list

hashtagGet settlement report list

hashtagGet settlement report in Excel format

Get seller product list

Approve or reject a seller product

Update product status

Generate Excel for vendor product

Get common catalog products

Set product as common

Get vendor category list

Create a new category

Get a list of industries

Get category translation list

Get category translation detail

Save category translations

Update category

Delete category

Get export log list

Get order Excel list

Get QR code product list

Get website settings

Generate QR code for products

Download QR code image

Get vendor orders

Get order detail

Get vendor order status log list

Get order status list

Export vendor order details as PDF

Update payment status of an order

Get back order list

Get failed order list

Get order details

Update main order payment details

Get payment list

Get live cart list or count

Get cart details by ID

Send email for abandoned cart

Export cart data

Delete abandoned cart list

Retrieve seller list

Retrieve a list of vendor orders

Get settlement list

Create a new settlement

Get settlement details by ID

Download settlement export in Excel format

Retrieve product list with filters

Retrieve sales report list for a product within a date range

Retrieve total seller sales list within a specified date and amount range

Retrieve total seller sales report in Excel format within a specified date and amount range

Retrieve vendor sales report list

Get settlement report list

Get settlement report in Excel format