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
integer
None.
ItemsPerPage
integer
None.
OrderBy
string
None.
SortOrder
string
None.
DateUpdated
date
None.
UpdatedSince
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-01-16T12:21",
  "UpdatedSince": {
    "FromDate": "2019-01-16T12:21",
    "ToDate": "2019-01-16T12:22",
    "FilterByTime": true
  }
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
Id
string
None.
CustomerNumber
integer
None.
Company
string
None.
FirstName
string
None.
LastName
string
None.
Email
string
None.
Phone
string
None.
City
string
None.
State
string
None.
Country
string
None.
ClientType
string
None.
HasTag
boolean
None.
UpdatedBy
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-01-16T12:21"
}