POST POS/Sales/Orders/Search Try Now

Search the order

Request Information

URI Parameters

NameDescriptionTypeAdditional information

Body Parameters

The request.

NameDescriptionTypeAdditional information
OrderId
The invoice identifier.
string
None.
OrderNumber
The invoice number.
long
None.
ExternalOrderNumber
The external order number.
string
None.
CustomerId
The customer identifier.
string
None.
Email
The email.
string
None.
Company
The company.
string
None.
ShippingStatus
The shipping status.
Collection of ShippingStatus
None.
PaymentStatus
The payment status.
Collection of PaymentStatus
None.
OrderStatus
The invoice status.
Collection of SearchOrderStatus
None.
ZoneCode
The zone code.
Zone
None.
OrderDate
The invoice date.
DateValue
None.
DateAdded
Date Added
DateValue
None.
Tags
Tags
Collection of string
None.
OrderBy
Sets the order by.(Note: Please use column Name Given in Response only,Don't use "Page" or "ItemsPerPage").
string
None.
SortOrder
The SortOrder i.e. "ASC" or "DESC"
string
None.
DateUpdated
Set Date Updated you can use either Date Updated Or UpdatedSince.
date
None.
UpdatedSince
Set From Date and To Date value. Reeturn result for between date , From Date And To Date.
DateValue
None.
Page
Sets the page.
integer
None.
ItemsPerPage
Sets the items per page.
integer
None.

Request Formats

application/json, text/json

Sample:
{
  "OrderId": "",
  "OrderNumber": 2,
  "ExternalOrderNumber": "",
  "CustomerId": "",
  "Email": "",
  "Company": "",
  "ShippingStatus": [
    "Any"
  ],
  "PaymentStatus": [
    "Any"
  ],
  "OrderStatus": [
    "Any"
  ],
  "ZoneCode": "Any",
  "OrderDate": {
    "FromDate": "2019-05-24T19:23",
    "ToDate": "2019-05-24T19:24",
    "FilterByTime": true
  },
  "DateAdded": {
    "FromDate": "2019-05-24T19:23",
    "ToDate": "2019-05-24T19:24",
    "FilterByTime": true
  },
  "Tags": [
    ""
  ],
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-05-24T19:23",
  "UpdatedSince": {
    "FromDate": "2019-05-24T19:23",
    "ToDate": "2019-05-24T19:24",
    "FilterByTime": true
  },
  "Page": 10,
  "ItemsPerPage": 11
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
OrderId
the invoice identifier.
string
None.
OrderNumber
the invoice number.
long
None.
OrderStatus
the invoice status.
InvoiceStatus
None.
OrderDate
the invoice date.
date
None.
DateExpected
the date expected.
date
None.
DateReceived
the date received.
date
None.
DateUpdated
the date updated.
date
None.
CustomerId
the customer identifier.
string
None.
Company
the company.
string
None.
Phone
the phone.
string
None.
Email
the email.
string
None.
PaymentStatus
the payment status.
PaymentStatus
None.
ZoneCode
the zone code.
Zone
None.
ExternalOrderNumber
the external order number.
string
None.
SubTotal
the sub total.
Money
None.
Tax
the tax.
Money
None.
ServiceFee
the extra cost.
Money
None.
Commission
the commission.
Money
None.
Discount
the discount.
Money
None.
GrandTotal
the grand total.
Money
None.
BalanceAmount
the balance amount.
Money
None.
Shipping
the shipping.
ShippingInfo
None.
Notes
the notes.
string
None.
VoidReason
the void reason.
string
None.
Version
the version.
integer
None.
Currency
the currency.
string
None.

Response Formats

application/json, text/json

Sample:
{
  "OrderId": "",
  "OrderNumber": 2,
  "OrderStatus": "Any",
  "OrderDate": "2019-05-24T19:23",
  "DateExpected": "2019-05-24T19:23",
  "DateReceived": "2019-05-24T19:23",
  "DateUpdated": "2019-05-24T19:23",
  "CustomerId": "",
  "Company": "",
  "Phone": "",
  "Email": "",
  "PaymentStatus": "Any",
  "ZoneCode": "Any",
  "ExternalOrderNumber": "",
  "SubTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "Tax": {
    "Currency": "",
    "Amount": 1.0
  },
  "ServiceFee": {
    "Currency": "",
    "Amount": 1.0
  },
  "Commission": {
    "Currency": "",
    "Amount": 1.0
  },
  "Discount": {
    "Currency": "",
    "Amount": 1.0
  },
  "GrandTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "BalanceAmount": {
    "Currency": "",
    "Amount": 1.0
  },
  "Shipping": {
    "Cost": 1.0,
    "Status": "Any",
    "Type": "None",
    "Carrier": "None",
    "Service": "",
    "TrackingNumber": "",
    "DateShipped": "2019-05-24T19:23",
    "LabelId": ""
  },
  "Notes": "",
  "VoidReason": "",
  "Version": 14,
  "Currency": ""
}