Manage Sales

order list

Get list of orders.

GET/order/orderlist

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

order detail

Get a list of order.

GET/order/order-detail

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

order export pdf

Export the order pdf.

GET/order/order-export-pdf

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "pdf exported"
}

sales graph list

List of salse graph list

GET/order/sales-graph-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

transaction list

Order transaction list.

GET/order/transaction-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

total order count

Count of today orders.

GET/order/today-order-count

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got the total order amount"
}

today order amount

Amount of today order.

GET/order/today-order-amount

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got the today order amount"
}

order change status

Status of order changes.

POST/order/order-change-status

Header parameters

Body

application/x-www-form-urlencoded

orderId*integer (int32)

orderStatusId*integer (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderIdinteger (int32)

customerIdinteger (int32)

currencyIdinteger (int32)

shippingZoneIdinteger (int32)

paymentZoneIdinteger (int32)

shippingCountryIdinteger (int32)

paymentCountryIdinteger (int32)

invoiceNostring

invoicePrefixstring

firstnamestring

lastnamestring

emailstring

telephonestring

faxstring

shippingFirstnamestring

shippingLastnamestring

shippingCompanystring

shippingAddress1string

shippingAddress2string

shippingCitystring

shippingPostcodestring

shippingCountrystring

shippingZonestring

shippingAddressFormatstring

shippingMethodinteger (int32)

paymentFirstnamestring

paymentLastnamestring

paymentCompanystring

paymentAddress1string

paymentAddress2string

paymentCitystring

paymentPostcodestring

paymentCountrystring

paymentZonestring

paymentAddressFormatstring

paymentMethodstring

commentstring

couponCodestring

discountAmountstring

amountstring

totalstring

rewardstring

orderStatusIdstring

orderPrefixIdstring

affiliateIdinteger (date-time)

commisionstring

currencyCodestring

currencyValueinteger (int32)

currencySymbolLeftstring

currencySymbolRightinteger (int32)

ipstring

paymentFlagstring

paymentStatusinteger (int32)

trackingUrlstring

trackingNointeger (int32)

orderNamestring

paymentTypeinteger (int32)

paymentProcessinteger (int32)

paymentDetailsstring

backOrdersinteger (int32)

isActiveinteger (int32)

customerGstNostring

orderLogIdinteger (int32)

Request

JavaScriptCurl

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

Response

{
  "createdDate": "2024-04-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "invoiceNo": "text",
  "invoicePrefix": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "telephone": "text",
  "fax": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingCompany": "text",
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingCity": "text",
  "shippingPostcode": "text",
  "shippingCountry": "text",
  "shippingZone": "text",
  "shippingAddressFormat": "text",
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentCompany": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentCity": "text",
  "paymentPostcode": "text",
  "paymentCountry": "text",
  "paymentZone": "text",
  "paymentAddressFormat": "text",
  "paymentMethod": "text",
  "comment": "text",
  "couponCode": "text",
  "discountAmount": "text",
  "amount": "text",
  "total": "text",
  "reward": "text",
  "orderStatusId": "text",
  "orderPrefixId": "text",
  "commision": "text",
  "currencyCode": "text",
  "currencySymbolLeft": "text",
  "ip": "text",
  "paymentFlag": "text",
  "trackingUrl": "text",
  "orderName": "text",
  "paymentDetails": "text",
  "customerGstNo": "text"
}

order excel list

Get order list on excel sheet.

GET/order/order-excel-list

Query parameters

Header parameters

Response

400

error response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Invalid orderId"
}

delete order

Remove the exist order.

DELETE/order/delete-order/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Order Deleted Successfully"
}

delete order

Delete the exist orders.

POST/order/delete-order

Header parameters

Body

application/x-www-form-urlencoded

orderIdarray of integer

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Order Deleted Successfully"
}

Order log list.

GET/order/orderLoglist

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got the complete order Log list"
}

Update payment status.

Update the payment status

POST/order/update-payment-status

Query parameters

Header parameters

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderIdinteger (int32)

customerIdinteger (int32)

currencyIdinteger (int32)

shippingZoneIdinteger (int32)

paymentZoneIdinteger (int32)

shippingCountryIdinteger (int32)

paymentCountryIdinteger (int32)

invoiceNostring

invoicePrefixstring

firstnamestring

lastnamestring

emailstring

telephonestring

faxstring

shippingFirstnamestring

shippingLastnamestring

shippingCompanystring

shippingAddress1string

shippingAddress2string

shippingCitystring

shippingPostcodestring

shippingCountrystring

shippingZonestring

shippingAddressFormatstring

shippingMethodinteger (int32)

paymentFirstnamestring

paymentLastnamestring

paymentCompanystring

paymentAddress1string

paymentAddress2string

paymentCitystring

paymentPostcodestring

paymentCountrystring

paymentZonestring

paymentAddressFormatstring

paymentMethodstring

commentstring

couponCodestring

discountAmountstring

amountstring

totalstring

rewardstring

orderStatusIdinteger (int32)

orderPrefixIdstring

affiliateIdinteger (int32)

commisioninteger (int32)

currencyCodestring

currencyValuestring

currencySymbolLeftstring

currencySymbolRightstring

ipstring

trackingUrlstring

trackingNostring

orderNamestring

paymentTypestring

paymentProcessinteger (int32)

paymentDetailsstring

backOrdersinteger (int32)

isActiveinteger (int32)

customerGstNostring

Request

JavaScriptCurl

const response = await fetch('/order/update-payment-status', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "invoiceNo": "text",
  "invoicePrefix": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "telephone": "text",
  "fax": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingCompany": "text",
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingCity": "text",
  "shippingPostcode": "text",
  "shippingCountry": "text",
  "shippingZone": "text",
  "shippingAddressFormat": "text",
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentCompany": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentCity": "text",
  "paymentPostcode": "text",
  "paymentCountry": "text",
  "paymentZone": "text",
  "paymentAddressFormat": "text",
  "paymentMethod": "text",
  "comment": "text",
  "couponCode": "text",
  "discountAmount": "text",
  "amount": "text",
  "total": "text",
  "reward": "text",
  "orderPrefixId": "text",
  "currencyCode": "text",
  "currencyValue": "text",
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "ip": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "orderName": "text",
  "paymentType": "text",
  "paymentDetails": "text",
  "customerGstNo": "text"
}

Update shipping information.

Update the shipping information.

POST/order/update-shipping-information

Header parameters

Body

application/x-www-form-urlencoded

orderId*integer (int32)

trackingUrl*string

trackingNo*string

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderIdinteger (int32)

customerIdinteger (int32)

currencyIdinteger (int32)

shippingZoneIdinteger (int32)

paymentZoneIdinteger (int32)

shippingCountryIdinteger (int32)

paymentCountryIdinteger (int32)

invoiceNostring

invoicePrefixstring

firstnamestring

lastnamestring

emailstring

telephonestring

faxstring

shippingFirstnamestring

shippingLastnamestring

shippingCompanystring

shippingAddress1string

shippingAddress2string

shippingCitystring

shippingPostcodestring

shippingCountrystring

shippingZonestring

shippingAddressFormatstring

shippingMethodinteger (int32)

paymentFirstnamestring

paymentLastnamestring

paymentCompanystring

paymentAddress1string

paymentAddress2string

paymentCitystring

paymentPostcodestring

paymentCountrystring

paymentZonestring

paymentAddressFormatstring

paymentMethodstring

commentstring

couponCodestring

discountAmountstring

amountstring

totalstring

rewardstring

orderStatusIdinteger (int32)

orderPrefixIdstring

affiliateIdinteger (int32)

commisionstring

currencyCodestring

currencyValuestring

currencySymbolLeftstring

currencySymbolRightstring

ipstring

paymentFlaginteger (int32)

paymentStatusinteger (int32)

trackingUrlstring

trackingNostring

orderNamestring

paymentTypestring

paymentProcessinteger (int32)

paymentDetailsstring

backOrdersinteger (int32)

isActiveinteger (int32)

customerGstNostring

Request

JavaScriptCurl

const response = await fetch('/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-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "invoiceNo": "text",
  "invoicePrefix": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "telephone": "text",
  "fax": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingCompany": "text",
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingCity": "text",
  "shippingPostcode": "text",
  "shippingCountry": "text",
  "shippingZone": "text",
  "shippingAddressFormat": "text",
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentCompany": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentCity": "text",
  "paymentPostcode": "text",
  "paymentCountry": "text",
  "paymentZone": "text",
  "paymentAddressFormat": "text",
  "paymentMethod": "text",
  "comment": "text",
  "couponCode": "text",
  "discountAmount": "text",
  "amount": "text",
  "total": "text",
  "reward": "text",
  "orderPrefixId": "text",
  "commision": "text",
  "currencyCode": "text",
  "currencyValue": "text",
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "ip": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "orderName": "text",
  "paymentType": "text",
  "paymentDetails": "text",
  "customerGstNo": "text"
}

Update order product shipping information.

Update the order product shipping information

POST/order/update-order-product-shipping-information

Header parameters

Body

application/x-www-form-urlencoded

orderProductId*integer (int32)

trackingUrl*string

trackingNo*string

Response

200400

success response

Body

application/json

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

couponDiscountAmountinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/order/update-order-product-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-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "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"
}

Update-order-product-status.

Update the order product status

PUT/order/update-order-product-status/{orderProductId}

Path parameters

orderProductId*integer

Header parameters

Body

application/x-www-form-urlencoded

orderStatusIdinteger (int32)

Response

200400

success response

Body

application/json

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

discountedAmountstring

orderStatusIdinteger (int32)

trackingUrlstring

trackingNostring

tracestring

taxstring

cancelRequestinteger (int32)

cancelRequestStatusinteger (int32)

cancelReasonstring

cancelReasonDescriptionstring

isActiveinteger (int32)

skuNamestring

couponDiscountAmountinteger (int32)

Request

JavaScriptCurl

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

Response

{
  "createdDate": "2024-04-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "orderProductPrefixId": "text",
  "name": "text",
  "model": "text",
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "total": "text",
  "discountedAmount": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "trace": "text",
  "tax": "text",
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "skuName": "text"
}

order product log list

Get list of order product log.

GET/order/order-product-log-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got the complete Order Product Log list"
}

order count

Get total count of order.

GET/order/order-count

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got the Order Counts"
}

Order cancel request list.

List of order cancel request.

GET/order/order-cancel-request-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got the order count \" or \" Successfully shown the order product cancel list"
}

Update order cancel request.

Update the order cancel request.

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

Path parameters

orderProductId*integer

Header parameters

Body

application/x-www-form-urlencoded

cancelStatusId*integer (int32)

Response

200400

success response

Body

application/json

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

taxinteger (int32)

cancelRequestinteger (int32)

cancelRequestStatusinteger (int32)

cancelReasonstring

cancelReasonDescriptionstring

isActiveinteger (int32)

skuNamestring

couponDiscountAmountinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/order/update-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-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "orderProductPrefixId": "text",
  "name": "text",
  "model": "text",
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "total": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "trace": "text",
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "skuName": "text"
}

Update bulk order cancel request.

Update the bulk order cancel request

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

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully accepted the cancelled orders \" or \" Successfully rejected the cancelled orders"
}

order cancel excel list

Excel list of order cancel.

GET/order/order-cancel-excel-list

Query parameters

Header parameters

Response

400

error response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Invalid orderProductId"
}

bulk order cancel excel list

Excel list of bulk order cancel.

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

Query parameters

Header parameters

Response

400

error response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "file is empty"
}

back order list

List of bulk order.

GET/order/back-order-list

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

failed-order-list

List of failed order.

GET/order/failed-order-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "uccessfully got count \" or \" Successfully got the failed order list"
}

update main order

Update the main order.

POST/order/update-main-order

Header parameters

Body

application/x-www-form-urlencoded

orderId*integer (int32)

paymentMethod*string

paymentRefId*string

paymentStatus*integer (int32)

paymentDetailstring

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully updated your order"
}

order count for list

List of order count.

GET/order/order-count-for-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully shown the order count"
}

product list

List of product.

GET/order/product-list

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Limit suggestion Showing Successfully..!"
}

sales report list

List of salse report.

GET/order/sales-report-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

Order Status

create order status

Add a category order status.

POST/order-status/create-order-status

Header parameters

Body

application/x-www-form-urlencoded

name*string

colorCode*string

priorityinteger (int32)

status*integer (int32)

parentIdinteger (int32)

isAdmininteger (int32)

isVendorinteger (int32)

isBuyerinteger (int32)

isApiinteger (int32)

Response

200400

success response

Body

application/json

namestring

colorCodestring

priorityinteger (int32)

isActivestring

parentIdstring

createdDatestring

orderStatusIdinteger (int32)

Request

JavaScriptCurl

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

Response

{
  "name": "text",
  "colorCode": "text",
  "isActive": "text",
  "parentId": "text",
  "createdDate": "text"
}

update order status

Update a category order status.

PUT/order-status/update-order-status/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

name*string

colorCode*string

priorityinteger (int32)

status*integer (int32)

parentIdinteger (int32)

isAdmininteger (int32)

isVendorinteger (int32)

isBuyerinteger (int32)

isApiinteger (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderStatusIdinteger (int32)

namestring

isActivestring

prioritystring

parentIdinteger (int32)

defaultStatusinteger (int32)

colorCodestring

Request

JavaScriptCurl

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

Response

{
  "createdDate": "2024-04-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "name": "text",
  "isActive": "text",
  "priority": "text",
  "colorCode": "text"
}

update order fullfillment status

Get list of the category order status.

PUT/order-status/update-order-fullfillment-status/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

statusinteger (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderStatusIdinteger (int32)

namestring

isActiveinteger (int32)

priorityinteger (int32)

parentIdinteger (int32)

defaultStatusinteger (int32)

isAdmininteger (int32)

isVendorinteger (int32)

isBuyerinteger (int32)

isApiinteger (int32)

colorCodestring

Request

JavaScriptCurl

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

Response

{
  "createdDate": "2024-04-28T23:56:55.683Z",
  "modifiedDate": "2024-04-28T23:56:55.683Z",
  "name": "text",
  "colorCode": "text"
}

order-fullfillment-status-list

Get list of order fullfillment status.

GET/order-status/order-fullfillment-status-list

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

order status list based on parent

Get the order status list based on parent.

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

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

order-status-list

Get list of order status.

GET/order-status/order-status-list

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

delete order status

Delete a order status.

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

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully deleted the order status. \" or \" Status is mapped with order product, so you cant delete it."
}