Customer Order

Customer checkout

POST/orders/customer-checkout

Header parameters

Body

shippingFirstNamestring

shippingLastNamestring

shippingAddress_1string

shippingCitystring

shippingPostCodeinteger (int32)

shippingZonestring

phoneNumberinteger (int32)

emailIdstring

shippingAddress_2string

shippingCompanystring

shippingCountryIdinteger (int32)

shippingAddressFormatstring

passwordstring

paymentMethodinteger (int32)

couponCodestring

couponDiscountAmountinteger (int32)

couponDatastring

productDetailsarray of object

isMobileboolean

taxNumberstring

paymentFirstNamestring

paymentLastNamestring

paymentAddress_1string

paymentCitystring

paymentPostCodeinteger (int32)

paymentZonestring

paymentAddress_2string

paymentCompanystring

paymentCountryIdinteger (int32)

Response

success response

Body

affiliateIdinteger (int32)

amountstring

backOrdersinteger (int32)

commentstring

commisioninteger (int32)

couponCodestring

createdByinteger (int32)

createdDatestring (date-time)

currencyCodestring

currencyIdinteger (int32)

currencySymbolLeftstring

currencySymbolRightstring

currencyValuestring

customerGstNostring

customerIdinteger (int32)

discountAmountstring

emailstring

faxstring

firstnamestring

invoiceNo0string

invoicePrefixstring

ipstring

isActiveinteger (int32)

lastnamestring

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderIdinteger (int32)

orderNamestring

orderPrefixIdstring

orderStatusIdinteger (int32)

paymentAddress1string

paymentAddress2string

paymentAddressFormatstring

paymentCitystring

paymentCompanystring

paymentCountrystring

paymentCountryIdinteger (int32)

paymentDetailsstring

paymentFirstnamestring

paymentFlaginteger (int32)

paymentLastnamestring

paymentMethodstring

paymentPostcodestring

paymentProcessinteger

paymentStatusinteger (int32)

paymentTypestring

paymentZonestring

productDetailarray of checkoutProductDetail (object)

rewardinteger (int32)

shippingAddress1string

shippingAddress2string

shippingAddressFormatstring

shippingCitystring

shippingCompanystring

shippingCountrystring

shippingCountryIdinteger (int32)

shippingFirstnamestring

shippingLastnamestring

shippingMethodinteger (int32)

shippingPostcodestring

shippingZonestring

shippingZoneIdinteger (int32)

telephonestring

totalstring

trackingNointeger (int32)

trackingUrlstring

Request

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

Response

{
  "amount": "text",
  "comment": "text",
  "couponCode": "text",
  "createdDate": "2024-04-29T06:14:56.808Z",
  "currencyCode": "text",
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "currencyValue": "text",
  "customerGstNo": "text",
  "discountAmount": "text",
  "email": "text",
  "fax": "text",
  "firstname": "text",
  "invoiceNo0": "text",
  "invoicePrefix": "text",
  "ip": "text",
  "lastname": "text",
  "modifiedDate": "2024-04-29T06:14:56.808Z",
  "orderName": "text",
  "orderPrefixId": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentAddressFormat": "text",
  "paymentCity": "text",
  "paymentCompany": "text",
  "paymentCountry": "text",
  "paymentDetails": "text",
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentMethod": "text",
  "paymentPostcode": "text",
  "paymentType": "text",
  "paymentZone": "text",
  "productDetail": [
    {
      "basePrice": "text",
      "cancelReason": "text",
      "cancelReasonDescription": "text",
      "couponDiscountAmount": "text",
      "createdDate": "2024-04-29T06:14:56.808Z",
      "discountAmount": "text",
      "discountedAmount": "text",
      "image": {
        "containerName": "text",
        "createdDate": "2024-04-29T06:14:56.808Z",
        "image": "text",
        "isActive": 0,
        "modifiedBy": 0,
        "modifiedDate": "2024-04-29T06:14:56.808Z"
      },
      "model": "text",
      "modifiedDate": "text",
      "name": "text",
      "orderProductPrefixId": "text",
      "productPrice": "text",
      "skuName": "text",
      "total": "text",
      "trace": "text",
      "trackingUrl": "text"
    }
  ],
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingAddressFormat": "text",
  "shippingCity": "text",
  "shippingCompany": "text",
  "shippingCountry": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingPostcode": "text",
  "shippingZone": "text",
  "telephone": "text",
  "total": "text",
  "trackingUrl": "text"
}

Back order checkout

POST/orders/back-order-checkout

Header parameters

Body

shippingFirstNamestring

shippingLastNamestring

shippingAddress_1string

shippingCitystring

shippingPostCodeinteger (int32)

shippingZonestring

phoneNumberinteger (int32)

emailIdstring

shippingAddress_2string

shippingCompanystring

shippingCountryIdinteger (int32)

shippingAddressFormatstring

passwordstring

paymentMethodinteger (int32)

productDetailsarray of object

isMobileboolean

Response

success response

Body

affiliateIdinteger (int32)

amountstring

backOrdersinteger (int32)

commentstring

commisioninteger (int32)

couponCodestring

createdByinteger (int32)

createdDatestring (date-time)

currencyCodestring

currencyIdinteger (int32)

currencySymbolLeftstring

currencySymbolRightstring

currencyValuestring

customerGstNostring

customerIdinteger (int32)

discountAmountstring

emailstring

faxstring

firstnamestring

invoiceNo0string

invoicePrefixstring

ipstring

isActiveinteger (int32)

lastnamestring

modifiedByinteger (int32)

modifiedDatestring (date-time)

orderIdinteger (int32)

orderNamestring

orderPrefixIdstring

orderStatusIdinteger (int32)

paymentAddress1string

paymentAddress2string

paymentAddressFormatstring

paymentCitystring

paymentCompanystring

paymentCountrystring

paymentCountryIdinteger (int32)

paymentDetailsstring

paymentFirstnamestring

paymentFlaginteger (int32)

paymentLastnamestring

paymentMethodstring

paymentPostcodestring

paymentProcessinteger

paymentStatusinteger (int32)

paymentTypestring

paymentZonestring

productDetailarray of checkoutProductDetail (object)

rewardinteger (int32)

shippingAddress1string

shippingAddress2string

shippingAddressFormatstring

shippingCitystring

shippingCompanystring

shippingCountrystring

shippingCountryIdinteger (int32)

shippingFirstnamestring

shippingLastnamestring

shippingMethodinteger (int32)

shippingPostcodestring

shippingZonestring

shippingZoneIdinteger (int32)

telephonestring

totalstring

trackingNointeger (int32)

trackingUrlstring

Request

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

Response

{
  "amount": "text",
  "comment": "text",
  "couponCode": "text",
  "createdDate": "2024-04-29T06:14:56.808Z",
  "currencyCode": "text",
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "currencyValue": "text",
  "customerGstNo": "text",
  "discountAmount": "text",
  "email": "text",
  "fax": "text",
  "firstname": "text",
  "invoiceNo0": "text",
  "invoicePrefix": "text",
  "ip": "text",
  "lastname": "text",
  "modifiedDate": "2024-04-29T06:14:56.808Z",
  "orderName": "text",
  "orderPrefixId": "text",
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentAddressFormat": "text",
  "paymentCity": "text",
  "paymentCompany": "text",
  "paymentCountry": "text",
  "paymentDetails": "text",
  "paymentFirstname": "text",
  "paymentLastname": "text",
  "paymentMethod": "text",
  "paymentPostcode": "text",
  "paymentType": "text",
  "paymentZone": "text",
  "productDetail": [
    {
      "basePrice": "text",
      "cancelReason": "text",
      "cancelReasonDescription": "text",
      "couponDiscountAmount": "text",
      "createdDate": "2024-04-29T06:14:56.808Z",
      "discountAmount": "text",
      "discountedAmount": "text",
      "image": {
        "containerName": "text",
        "createdDate": "2024-04-29T06:14:56.808Z",
        "image": "text",
        "isActive": 0,
        "modifiedBy": 0,
        "modifiedDate": "2024-04-29T06:14:56.808Z"
      },
      "model": "text",
      "modifiedDate": "text",
      "name": "text",
      "orderProductPrefixId": "text",
      "productPrice": "text",
      "skuName": "text",
      "total": "text",
      "trace": "text",
      "trackingUrl": "text"
    }
  ],
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingAddressFormat": "text",
  "shippingCity": "text",
  "shippingCompany": "text",
  "shippingCountry": "text",
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingPostcode": "text",
  "shippingZone": "text",
  "telephone": "text",
  "total": "text",
  "trackingUrl": "text"
}

Order list

List of customer order

GET/orders/order-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

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

Response

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

Order detail

List of order detail

GET/orders/order-detail

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

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

Response

{
  "message": "Successfully show the order details"
}

Track order

List of track order

GET/orders/track-order-product

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

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

Response

{
  "message": "Successfully shown the Track Order."
}

Order export pdf

GET/orders/order-export-pdf

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

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

Response

{
  "message": "text"
}

Order cancel reason list

List of order cancel reason

GET/orders/order-cancel-reason-list

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

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

Response

{
  "message": "Successfully got Order Cancel Reason list"
}

Order cancel request

Request of order cancel

POST/orders/order-cancel-request

Header parameters

Body

reasonId*integer (int32)

orderProductId*integer (int32)

descriptionstring

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

discountedAmountstring

orderStatusIdinteger (int32)

trackingUrlstring

trackingNostring

traceinteger (int32)

taxinteger (int32)

cancelRequestinteger (int32)

cancelRequestStatusinteger (int32)

cancelReasonstring

cancelReasonDescriptionstring

isActiveinteger (int32)

skuNamestring

couponDiscountAmountstring

Request

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

Response

{
  "createdDate": "2024-04-29T06:14:56.808Z",
  "modifiedDate": "2024-04-29T06:14:56.808Z",
  "orderProductPrefixId": "text",
  "name": "text",
  "model": "text",
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "total": "text",
  "discountedAmount": "text",
  "trackingUrl": "text",
  "trackingNo": "text",
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "skuName": "text",
  "couponDiscountAmount": "text"
}

Get order payment status

GET/orders/get-order-payment-status

Query parameters

Header parameters

Response

success response

Body

statusinteger

messagestring

Request

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

Response

{
  "message": "Successfully got payment."
}

PreviousCommon list api NextCustomer wish List

Last updated 1 year ago