Manage sales | API Reference

recent order list

List of recent order

GET/vendor-order/recent-order-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/recent-order-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got count. \" or \" Successfully got the complete order list."
}

Vendor order detail

Get detail of vendor order

GET/vendor-order/order-detail/{vendorOrderId}

Path parameters

vendorOrderId*integer

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/order-detail/{vendorOrderId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully shown the order Detail."
}

Archive order detail

Get detail of vendor archive order.

GET/vendor-order/archive-order-detail/{vendorOrderArchiveId}

Path parameters

vendorOrderArchiveId*integer

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/archive-order-detail/{vendorOrderArchiveId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully shown the archive order Detail."
}

Today vendor order count

Get count of today vendor order

GET/vendor-order/today-vendor-order-count

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/today-vendor-order-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get Today order count"
}

Vendor order count

Get count of vendor order

GET/vendor-order/order-counts

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/order-counts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get Today order count"
}

Delete vendor order

Delete a vendor order

DELETE/vendor-order/delete-vendor-order/{id}

Path parameters

id*integer

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/delete-vendor-order/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Order Deleted Successfully"
}

Update vendor order status

Update a vendor order status

PUT/vendor-order/update-order-status/{vendorOrderId}

Path parameters

vendorOrderId*integer

Header parameters

Body

subOrderStatusIdinteger (int32)

Response

success response

Body

createdByinteger (int32)

createdDateinteger (date-time)

modifiedByinteger (int32)

modifiedDateinteger (date-time)

vendorOrderIdinteger (int32)

subOrderIdstring

vendorIdinteger (int32)

subOrderStatusIdinteger (int32)

orderProductIdinteger (int32)

orderIdinteger (int32)

totalstring

commissioninteger (int32)

trackingUrlstring

trackingNostring

makeSettlementinteger (int32)

namestring

Request

const response = await fetch('/vendor-order/update-order-status/{vendorOrderId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "subOrderId": "text",
  "total": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "name": "text"
}

Vendor order status list

GET/vendor-order/vendor-order-status-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-order-status-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Vendor orders based status list

Get list of vendor orders based status.

GET/vendor-order/vendor-orders-based-status-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-orders-based-status-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Vendor orders based status details

Get detail of vendor order based status.

GET/vendor-order/vendor-orders-based-status-details/{orderStatusId}

Path parameters

orderStatusId*integer

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-orders-based-status-details/{orderStatusId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the vendor order count \" or \" Successfully got the vendor order details."
}

Vendor orders based status count

Get count of vendor based status

GET/vendor-order/vendor-orders-based-status-count

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-orders-based-status-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the vendor order status count."
}

Vendor log list

Get list of vendor log

GET/vendor-order/vendorOrderLoglist

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendorOrderLoglist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "vendorOrderId"
}

Top selling product list

Get list of top selling product

GET/vendor-order/top-selling-productlist

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/top-selling-productlist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get Top Selling Product..!"
}

Update shipping information

POST/vendor-order/update-shipping-information

Header parameters

Body

vendorOrderId*integer (int32)

trackingUrl*string

trackingNo*string

Response

success response

Body

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

vendorOrderIdinteger (int32)

subOrderIdstring

vendorIdinteger (int32)

subOrderStatusIdinteger (int32)

orderProductIdinteger (int32)

orderIdinteger (int32)

totalstring

commissioninteger (int32)

trackingUrlstring

trackingNostring

makeSettlementinteger (int32)

Request

const response = await fetch('/vendor-order/update-shipping-information ', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "trackingNo": "text",
      "trackingUrl": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T20:35:47.828Z",
  "modifiedDate": "2024-04-28T20:35:47.828Z",
  "subOrderId": "text",
  "total": "text",
  "trackingUrl": "text",
  "trackingNo": "text"
}

Order export pdf

GET/vendor-order/order-export-pdf

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/order-export-pdf', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "pdf exported"
}

Make vendor order archive

POST/vendor-order/make-vendor-order-archive

Header parameters

Body

vendorOrderId*integer (int32)

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/make-vendor-order-archive', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Successfully revoked archived order"
}

Revoke vendor order archive

Revoke the archive order of vendor

POST/vendor-order/revoke-vendor-order-archive

Header parameters

Body

vendorOrderArchiveIdinteger (int32)

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/revoke-vendor-order-archive', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Successfully archived"
}

Get list of vendor archive order

GET/vendor-order/archive-order-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/archive-order-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the complete order archive list."
}

archive-order-list-count

Get count of vendor order list

GET/vendor-order/archive-order-list-count

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/archive-order-list-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the complete order archive list count."
}

Vendor order list

Get list of vendor order list

GET/vendor-order/order-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/order-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the vendor orders count"
}

Bulk archive order export

Export the bulk archive order

GET/vendor-order/bulk-archive-order-export

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/bulk-archive-order-export', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully archive order exported"
}

Archive order export

Export the archive order

GET/vendor-order/archive-order-export

Query parameters

Header parameters

Response

error response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/archive-order-export', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Invalid ArchiveId"
}

Cancel order list

Get list of cancel order

GET/vendor-order/cancel-order-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/cancel-order-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the cancel request count. \" Successfully got the complete cancel order list."
}

Update vendor order cancel request

Update the vendor order cancel request

PUT/vendor-order/update-vendor-order-cancel-request/{orderProductId}

Path parameters

orderProductId*integer

Header parameters

Body

cancelStatusId*integer (int32)

Response

success response

Body

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderProductIdinteger (int32)

productIdinteger (int32)

orderProductPrefixIdstring

orderIdinteger (int32)

namestring

modelstring

quantityinteger (int32)

productPricestring

discountAmountstring

basePricestring

taxTypeinteger (int32)

taxValueinteger (int32)

totalstring

discountedAmountinteger (int32)

orderStatusIdinteger (int32)

trackingUrlstring

trackingNostring

tracestring

taxstring

cancelRequestinteger (int32)

cancelRequestStatusinteger (int32)

cancelReasonstring

cancelReasonDescriptionstring

isActiveinteger (int32)

skuNamestring

couponDiscountAmountstring

Request

const response = await fetch('/vendor-order/update-vendor-order-cancel-request/{orderProductId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T20:35:47.828Z",
  "modifiedDate": "2024-04-28T20:35:47.828Z",
  "orderProductPrefixId": "text",
  "name": "text",
  "model": "text",
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "total": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "trace": "text",
  "tax": "text",
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "skuName": "text",
  "couponDiscountAmount": "text"
}

Update bulk vendor order cancel request

GET/vendor-order/update-bulk-vendor-order-cancel-request

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/update-bulk-vendor-order-cancel-request', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully updated the order cancel status."
}

Vendor order cancel excel list

Get excel list of vendor order cancel

GET/vendor-order/vendor-order-cancel-excel-list

Query parameters

Header parameters

Response

error response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-order-cancel-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Invalid orderProductId"
}

Bulk vendor order cancel excel list

Get excel list of cancel bulk vendor order

GET/vendor-order/bulk-vendor-order-cancel-excel-list

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/bulk-vendor-order-cancel-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the list"
}

Vendor invoice list

Get list of vendor invoice

GET/vendor-order/vendor-invoice-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-invoice-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the cancel request count. \" or \" Successfully got the vendor invoice list."
}

Order invoice export pdf

Export pdf of order invoice

GET/vendor-order/order-invoice-export-pdf

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/order-invoice-export-pdf', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "pdf exported"
}

Salse report list

Get list of salse report

GET/vendor-order/sales-report-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/sales-report-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got vendor sales count. \" or \" Successfully got vendor sales list."
}

Sales report export list

Get list of sales report export

GET/vendor-order/sales-report-export-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/sales-report-export-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get the list of sales report export"
}

Order invoice export send email pdf

POST/vendor-order/order-invoice-export-send-email-pdf

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/order-invoice-export-send-email-pdf', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Mail sent to you"
}

Back order list

Get list of back order

GET/vendor-order/back-order-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/back-order-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get Count. \" or \" Successfully shown the Back Order list."
}

Vendor failed order list

Get list of vendor failed order

GET/vendor-order/vendor-failed-order-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-failed-order-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the cancel request count. \" or \" Successfully got the vendor failed Order list."
}

Bulk back order excel list

Get excel list of bulk back order

GET/vendor-order/bulk-back-order-excel-list

Query parameters

Header parameters

Response

error response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/bulk-back-order-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "file is empty"
}

Back order excel list

GET/vendor-order/back-order-excel-list

Query parameters

Header parameters

Response

error response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/back-order-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "file is empty"
}

Failed order excel list

GET/vendor-order/failed-order-excel-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/failed-order-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get the failed order excel list"
}

Bulk failed order excel list

GET/vendor-order/bulk-failed-order-excel-list

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/bulk-failed-order-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get the bulk failed order excel list"
}

Vendor order status list based on parent

GET/vendor-order/vendor-order-status-list-based-on-parent

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

const response = await fetch('/vendor-order/vendor-order-status-list-based-on-parent', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got order status list based on parent."
}

Vendor payment list

List of vendor payment

GET/vendor-sales/payment-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

Response

Vendor payment list count

Count of vendor payment

GET/vendor-sales/payment-list-count

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

Response

Sales list export

List of vendor sales list

GET/vendor-sales/sales-export

Query parameters

Header parameters

Response

error response

Body

statusinteger

messagestring

Request

Response

Vendor payment counts

Get count for vendor payment

GET/vendor-sales/payment-counts

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

Response

Vendor sales export

Get excel export of vendor sales

GET/vendor-sales/vendor-sales-export

Query parameters

Header parameters

Response

error response

Body

statusinteger

messagestring

Request

Response

Make vendor archive payment

POST/vendor-sales/make-vendor-payment-archive

Header parameters

Body

vendorPaymentIdinteger (int32)

Response

success response

Body

statusinteger

messagestring

Request

Response

Archive payment list

Get list of archive payment

GET/vendor-sales/archive-payment-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

Response

Archive payment list count

Get count list of archive payment

GET/vendor-sales/archive-payment-list-count

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

Response

Bulk archive payment export

GET/vendor-sales/bulk-archive-payment-export

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

Response

Archive payment export

Get archive payment export

GET/vendor-sales/archive-payment-export

Query parameters

Header parameters

Response

error response

Body

statusinteger

messagestring

Request

Response