POST POS/Customers/Search Try Now

This api used to get list of customer by specified search parameters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

Body Parameters

The search customer request.

NameDescriptionTypeAdditional information
Tag
The tag.
string
None.
CustomerNumber
The customer number.
long
None.
Company
The company.
string
None.
FirstName
The first name.
string
None.
LastName
The last name.
string
None.
Email
The email.
string
None.
Phone
The phone.
string
None.
ClientType
The type of the client.
string
None.
IsPreferredVendor
Gets or sets a value indicating whether this instance is preferred vendor.
boolean
None.
IsPreferredClient
Gets or sets a value indicating whether this instance is preferred client.
boolean
None.
Tags
Collection of string
None.
Page
Sets the page.
integer
None.
ItemsPerPage
Sets the items per page.
integer
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.

Request Formats

application/json, text/json

Sample:
{
  "Tag": "",
  "CustomerNumber": 2,
  "Company": "",
  "FirstName": "",
  "LastName": "",
  "Email": "",
  "Phone": "",
  "ClientType": "",
  "IsPreferredVendor": true,
  "IsPreferredClient": true,
  "Tags": [
    ""
  ],
  "Page": 11,
  "ItemsPerPage": 12,
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-03-23T12:48",
  "UpdatedSince": {
    "FromDate": "2019-03-23T12:48",
    "ToDate": "2019-03-23T12:49",
    "FilterByTime": true
  }
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
Id
The identifier.
string
None.
CustomerNumber
The customer number.
integer
None.
Company
The company.
string
None.
FirstName
The first name.
string
None.
LastName
The last name.
string
None.
Email
The email.
string
None.
Phone
The phone.
string
None.
City
The city.
string
None.
State
The state.
string
None.
Country
The country.
string
None.
ClientType
The type of the client.
string
None.
HasTag
A value indicating whether this instance has tag.
boolean
None.
UpdatedBy
The updated by.
string
None.
DateUpdated
date
None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "",
  "CustomerNumber": 2,
  "Company": "",
  "FirstName": "",
  "LastName": "",
  "Email": "",
  "Phone": "",
  "City": "",
  "State": "",
  "Country": "",
  "ClientType": "",
  "HasTag": true,
  "UpdatedBy": "",
  "DateUpdated": "2019-03-23T12:48"
}