Customer Order

Customer checkout

post

Customer checkout

Header parameters

AuthorizationstringRequired

Body

shippingFirstNamestringOptional

shippingLastNamestringOptional

shippingAddress_1stringOptional

shippingCitystringOptional

shippingPostCodeinteger · int32Optional

shippingZonestringOptional

phoneNumberinteger · int32Optional

emailIdstringOptional

shippingAddress_2stringOptional

shippingCompanystringOptional

shippingCountryIdinteger · int32Optional

shippingAddressFormatstringOptional

passwordstringOptional

paymentMethodinteger · int32Optional

couponCodestringOptional

couponDiscountAmountinteger · int32Optional

couponDatastringOptional

productDetailsobject[]Optional

isMobilebooleanOptional

taxNumberstringOptional

paymentFirstNamestringOptional

paymentLastNamestringOptional

paymentAddress_1stringOptional

paymentCitystringOptional

paymentPostCodeinteger · int32Optional

paymentZonestringOptional

paymentAddress_2stringOptional

paymentCompanystringOptional

paymentCountryIdinteger · int32Optional

Responses

200

success response

application/json

affiliateIdinteger · int32Optional

amountstringOptional

backOrdersinteger · int32Optional

commentstringOptional

commisioninteger · int32Optional

couponCodestringOptional

createdByinteger · int32Optional

createdDatestring · date-timeOptional

currencyCodestringOptional

currencyIdinteger · int32Optional

currencySymbolLeftstringOptional

currencySymbolRightstringOptional

currencyValuestringOptional

customerGstNostringOptional

customerIdinteger · int32Optional

discountAmountstringOptional

emailstringOptional

faxstringOptional

firstnamestringOptional

invoiceNo0stringOptional

invoicePrefixstringOptional

ipstringOptional

isActiveinteger · int32Optional

lastnamestringOptional

modifiedByinteger · int32Optional

modifiedDatestring · date-timeOptional

orderIdinteger · int32Optional

orderNamestringOptional

orderPrefixIdstringOptional

orderStatusIdinteger · int32Optional

paymentAddress1stringOptional

paymentAddress2stringOptional

paymentAddressFormatstringOptional

paymentCitystringOptional

paymentCompanystringOptional

paymentCountrystringOptional

paymentCountryIdinteger · int32Optional

paymentDetailsstringOptional

paymentFirstnamestringOptional

paymentFlaginteger · int32Optional

paymentLastnamestringOptional

paymentMethodstringOptional

paymentPostcodestringOptional

paymentProcessintegerOptional

paymentStatusinteger · int32Optional

paymentTypestringOptional

paymentZonestringOptional

rewardinteger · int32Optional

shippingAddress1stringOptional

shippingAddress2stringOptional

shippingAddressFormatstringOptional

shippingCitystringOptional

shippingCompanystringOptional

shippingCountrystringOptional

shippingCountryIdinteger · int32Optional

shippingFirstnamestringOptional

shippingLastnamestringOptional

shippingMethodinteger · int32Optional

shippingPostcodestringOptional

shippingZonestringOptional

shippingZoneIdinteger · int32Optional

telephonestringOptional

totalstringOptional

trackingNointeger · int32Optional

trackingUrlstringOptional

400

error response

application/json

422

success response

application/json

post/orders/customer-checkout

POST /orders/customer-checkout HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 652

"shippingFirstName='text'&shippingLastName='text'&shippingAddress_1='text'&shippingCity='text'&shippingPostCode=1&shippingZone='text'&phoneNumber=1&emailId='text'&shippingAddress_2='text'&shippingCompany='text'&shippingCountryId=1&shippingAddressFormat='text'&password='text'&paymentMethod=1&couponCode='text'&couponDiscountAmount=1&couponData='text'&productDetails=[{}]&isMobile=true&taxNumber='text'&paymentFirstName='text'&paymentLastName='text'&paymentAddress_1='text'&paymentCity='text'&paymentPostCode=1&paymentZone='text'&paymentAddress_2='text'&paymentCompany='text'&paymentCountryId=1"

{
  "affiliateId": 1,
  "amount": "text",
  "backOrders": 1,
  "comment": "text",
  "commision": 1,
  "couponCode": "text",
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "currencyCode": "text",
  "currencyId": 1,
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "currencyValue": "text",
  "customerGstNo": "text",
  "customerId": 1,
  "discountAmount": "text",
  "email": "text",
  "fax": "text",
  "firstname": "text",
  "invoiceNo0": "text",
  "invoicePrefix": "text",
  "ip": "text",
  "isActive": 1,
  "lastname": "text",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "orderId": 1,
  "orderName": "text",
  "orderPrefixId": "text",
  "orderStatusId": 1,
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentAddressFormat": "text",
  "paymentCity": "text",
  "paymentCompany": "text",
  "paymentCountry": "text",
  "paymentCountryId": 1,
  "paymentDetails": "text",
  "paymentFirstname": "text",
  "paymentFlag": 1,
  "paymentLastname": "text",
  "paymentMethod": "text",
  "paymentPostcode": "text",
  "paymentProcess": 1,
  "paymentStatus": 1,
  "paymentType": "text",
  "paymentZone": "text",
  "productDetail": [
    {
      "basePrice": "text",
      "cancelReason": "text",
      "cancelReasonDescription": "text",
      "cancelRequest": 1,
      "cancelRequestStatus": 1,
      "couponDiscountAmount": "text",
      "createdBy": 1,
      "createdDate": "2026-01-01T00:00:00.000Z",
      "discountAmount": "text",
      "discountedAmount": "text",
      "image": {
        "containerName": "text",
        "createdBy": 1,
        "createdDate": "2026-01-01T00:00:00.000Z",
        "defaultImage": 1,
        "image": "text",
        "isActive": 1,
        "modifiedBy": 1,
        "modifiedDate": "2026-01-01T00:00:00.000Z",
        "productId": 1,
        "productImageId": 1,
        "sortOrder": 1
      },
      "isActive": 1,
      "model": "text",
      "modifiedBy": 1,
      "modifiedDate": "text",
      "name": "text",
      "orderId": 1,
      "orderProductId": 1,
      "orderProductPrefixId": "text",
      "orderStatusId": 1,
      "productId": 1,
      "productPrice": "text",
      "quantity": 1,
      "skuName": "text",
      "tax": 1,
      "taxType": 1,
      "taxValue": 1,
      "total": "text",
      "trace": "text",
      "trackingNo": 1,
      "trackingUrl": "text"
    }
  ],
  "reward": 1,
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingAddressFormat": "text",
  "shippingCity": "text",
  "shippingCompany": "text",
  "shippingCountry": "text",
  "shippingCountryId": 1,
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingMethod": 1,
  "shippingPostcode": "text",
  "shippingZone": "text",
  "shippingZoneId": 1,
  "telephone": "text",
  "total": "text",
  "trackingNo": 1,
  "trackingUrl": "text"
}

Back order checkout

post

Back order checkout

Header parameters

AuthorizationstringRequired

Body

shippingFirstNamestringOptional

shippingLastNamestringOptional

shippingAddress_1stringOptional

shippingCitystringOptional

shippingPostCodeinteger · int32Optional

shippingZonestringOptional

phoneNumberinteger · int32Optional

emailIdstringOptional

shippingAddress_2stringOptional

shippingCompanystringOptional

shippingCountryIdinteger · int32Optional

shippingAddressFormatstringOptional

passwordstringOptional

paymentMethodinteger · int32Optional

productDetailsobject[]Optional

isMobilebooleanOptional

Responses

200

success response

application/json

affiliateIdinteger · int32Optional

amountstringOptional

backOrdersinteger · int32Optional

commentstringOptional

commisioninteger · int32Optional

couponCodestringOptional

createdByinteger · int32Optional

createdDatestring · date-timeOptional

currencyCodestringOptional

currencyIdinteger · int32Optional

currencySymbolLeftstringOptional

currencySymbolRightstringOptional

currencyValuestringOptional

customerGstNostringOptional

customerIdinteger · int32Optional

discountAmountstringOptional

emailstringOptional

faxstringOptional

firstnamestringOptional

invoiceNo0stringOptional

invoicePrefixstringOptional

ipstringOptional

isActiveinteger · int32Optional

lastnamestringOptional

modifiedByinteger · int32Optional

modifiedDatestring · date-timeOptional

orderIdinteger · int32Optional

orderNamestringOptional

orderPrefixIdstringOptional

orderStatusIdinteger · int32Optional

paymentAddress1stringOptional

paymentAddress2stringOptional

paymentAddressFormatstringOptional

paymentCitystringOptional

paymentCompanystringOptional

paymentCountrystringOptional

paymentCountryIdinteger · int32Optional

paymentDetailsstringOptional

paymentFirstnamestringOptional

paymentFlaginteger · int32Optional

paymentLastnamestringOptional

paymentMethodstringOptional

paymentPostcodestringOptional

paymentProcessintegerOptional

paymentStatusinteger · int32Optional

paymentTypestringOptional

paymentZonestringOptional

rewardinteger · int32Optional

shippingAddress1stringOptional

shippingAddress2stringOptional

shippingAddressFormatstringOptional

shippingCitystringOptional

shippingCompanystringOptional

shippingCountrystringOptional

shippingCountryIdinteger · int32Optional

shippingFirstnamestringOptional

shippingLastnamestringOptional

shippingMethodinteger · int32Optional

shippingPostcodestringOptional

shippingZonestringOptional

shippingZoneIdinteger · int32Optional

telephonestringOptional

totalstringOptional

trackingNointeger · int32Optional

trackingUrlstringOptional

400

error response

application/json

post/orders/back-order-checkout

POST /orders/back-order-checkout HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 358

"shippingFirstName='text'&shippingLastName='text'&shippingAddress_1='text'&shippingCity='text'&shippingPostCode=1&shippingZone='text'&phoneNumber=1&emailId='text'&shippingAddress_2='text'&shippingCompany='text'&shippingCountryId=1&shippingAddressFormat='text'&password='text'&paymentMethod=1&productDetails=[{}]&isMobile=true"

{
  "affiliateId": 1,
  "amount": "text",
  "backOrders": 1,
  "comment": "text",
  "commision": 1,
  "couponCode": "text",
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "currencyCode": "text",
  "currencyId": 1,
  "currencySymbolLeft": "text",
  "currencySymbolRight": "text",
  "currencyValue": "text",
  "customerGstNo": "text",
  "customerId": 1,
  "discountAmount": "text",
  "email": "text",
  "fax": "text",
  "firstname": "text",
  "invoiceNo0": "text",
  "invoicePrefix": "text",
  "ip": "text",
  "isActive": 1,
  "lastname": "text",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "orderId": 1,
  "orderName": "text",
  "orderPrefixId": "text",
  "orderStatusId": 1,
  "paymentAddress1": "text",
  "paymentAddress2": "text",
  "paymentAddressFormat": "text",
  "paymentCity": "text",
  "paymentCompany": "text",
  "paymentCountry": "text",
  "paymentCountryId": 1,
  "paymentDetails": "text",
  "paymentFirstname": "text",
  "paymentFlag": 1,
  "paymentLastname": "text",
  "paymentMethod": "text",
  "paymentPostcode": "text",
  "paymentProcess": 1,
  "paymentStatus": 1,
  "paymentType": "text",
  "paymentZone": "text",
  "productDetail": [
    {
      "basePrice": "text",
      "cancelReason": "text",
      "cancelReasonDescription": "text",
      "cancelRequest": 1,
      "cancelRequestStatus": 1,
      "couponDiscountAmount": "text",
      "createdBy": 1,
      "createdDate": "2026-01-01T00:00:00.000Z",
      "discountAmount": "text",
      "discountedAmount": "text",
      "image": {
        "containerName": "text",
        "createdBy": 1,
        "createdDate": "2026-01-01T00:00:00.000Z",
        "defaultImage": 1,
        "image": "text",
        "isActive": 1,
        "modifiedBy": 1,
        "modifiedDate": "2026-01-01T00:00:00.000Z",
        "productId": 1,
        "productImageId": 1,
        "sortOrder": 1
      },
      "isActive": 1,
      "model": "text",
      "modifiedBy": 1,
      "modifiedDate": "text",
      "name": "text",
      "orderId": 1,
      "orderProductId": 1,
      "orderProductPrefixId": "text",
      "orderStatusId": 1,
      "productId": 1,
      "productPrice": "text",
      "quantity": 1,
      "skuName": "text",
      "tax": 1,
      "taxType": 1,
      "taxValue": 1,
      "total": "text",
      "trace": "text",
      "trackingNo": 1,
      "trackingUrl": "text"
    }
  ],
  "reward": 1,
  "shippingAddress1": "text",
  "shippingAddress2": "text",
  "shippingAddressFormat": "text",
  "shippingCity": "text",
  "shippingCompany": "text",
  "shippingCountry": "text",
  "shippingCountryId": 1,
  "shippingFirstname": "text",
  "shippingLastname": "text",
  "shippingMethod": 1,
  "shippingPostcode": "text",
  "shippingZone": "text",
  "shippingZoneId": 1,
  "telephone": "text",
  "total": "text",
  "trackingNo": 1,
  "trackingUrl": "text"
}

Order list

get

List of customer order

Query parameters

limitintegerOptional

offsetintegerOptional

keywordstringOptional

statusintegerOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully get Count. " or " Successfully shown the order list.

get/orders/order-list

GET /orders/order-list HTTP/1.1
Authorization: text
Accept: */*

200

success response

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

Order detail

get

List of order detail

Query parameters

orderProductIdintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully show the order details

400

error response

*/*

get/orders/order-detail

GET /orders/order-detail?orderProductId=1 HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully show the order details"
}

Track order

get

List of track order

Query parameters

orderProductIdintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully shown the Track Order.

400

error response

*/*

get/orders/track-order-product

GET /orders/track-order-product?orderProductId=1 HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully shown the Track Order."
}

Order export pdf

get

Order export pdf

Query parameters

orderProductIdintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: ""

400

error response

*/*

get/orders/order-export-pdf

GET /orders/order-export-pdf?orderProductId=1 HTTP/1.1
Authorization: text
Accept: */*

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

Order cancel reason list

get

List of order cancel reason

Query parameters

limitintegerOptional

offsetintegerOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully got Order Cancel Reason list

get/orders/order-cancel-reason-list

GET /orders/order-cancel-reason-list HTTP/1.1
Authorization: text
Accept: */*

200

success response

{
  "status": 1,
  "message": "Successfully got Order Cancel Reason list"
}

Order cancel request

post

Request of order cancel

Header parameters

AuthorizationstringRequired

Body

reasonIdinteger · int32Required

orderProductIdinteger · int32Required

descriptionstringOptional

Responses

200

success response

application/json

createdByinteger · int32Optional

createdDatestring · date-timeOptional

modifiedByinteger · int32Optional

modifiedDatestring · date-timeOptional

orderProductIdinteger · int32Optional

productIdinteger · int32Optional

orderProductPrefixIdstringOptional

orderIdinteger · int32Optional

namestringOptional

modelstringOptional

quantityinteger · int32Optional

productPricestringOptional

discountAmountstringOptional

basePricestringOptional

taxTypeinteger · int32Optional

taxValueinteger · int32Optional

totalstringOptional

discountedAmountstringOptional

orderStatusIdinteger · int32Optional

trackingUrlstringOptional

trackingNostringOptional

traceinteger · int32Optional

taxinteger · int32Optional

cancelRequestinteger · int32Optional

cancelRequestStatusinteger · int32Optional

cancelReasonstringOptional

cancelReasonDescriptionstringOptional

isActiveinteger · int32Optional

skuNamestringOptional

couponDiscountAmountstringOptional

400

error response

application/json

post/orders/order-cancel-request

POST /orders/order-cancel-request HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54

"reasonId=1&orderProductId=1&description='text'"

{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "orderProductId": 1,
  "productId": 1,
  "orderProductPrefixId": "text",
  "orderId": 1,
  "name": "text",
  "model": "text",
  "quantity": 1,
  "productPrice": "text",
  "discountAmount": "text",
  "basePrice": "text",
  "taxType": 1,
  "taxValue": 1,
  "total": "text",
  "discountedAmount": "text",
  "orderStatusId": 1,
  "trackingUrl": "text",
  "trackingNo": "text",
  "trace": 1,
  "tax": 1,
  "cancelRequest": 1,
  "cancelRequestStatus": 1,
  "cancelReason": "text",
  "cancelReasonDescription": "text",
  "isActive": 1,
  "skuName": "text",
  "couponDiscountAmount": "text"
}

Get order payment status

get

Get order payment status

Query parameters

orderPrefixIdstringRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully got payment.

400

error response

*/*

get/orders/get-order-payment-status

GET /orders/get-order-payment-status?orderPrefixId=text HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got payment."
}