POST api/customers/SearchCustomer
Request Information
URI Parameters
None.
Body Parameters
RequestFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| searchKey | string |
None. |
|
| billId | integer |
None. |
|
| locationId | integer |
None. |
|
| locationIds | Collection of integer |
None. |
|
| fromDate | date |
None. |
|
| toDate | date |
None. |
|
| billDate | date |
None. |
|
| vendorId | integer |
None. |
|
| staffId | integer |
None. |
|
| campaignId | integer |
None. |
|
| filterBy | string |
None. |
|
| noOfrecords | integer |
None. |
|
| noOfDays | integer |
None. |
|
| filterTime | string |
None. |
|
| Services | Collection of integer |
None. |
|
| memberships | Collection of integer |
None. |
|
| CustomerName | string |
None. |
|
| Mobile | string |
None. |
|
| groupBy | string |
None. |
|
| customerId | integer |
None. |
|
| activeOnly | boolean |
None. |
|
| membershipFilter | string |
None. |
|
| billItemFilter | Collection of string |
None. |
|
| appointmentId | integer |
None. |
|
| appointmentStatus | byte |
None. |
|
| comments | string |
None. |
|
| reason | string |
None. |
|
| startTimeString | string |
None. |
|
| endTimeString | string |
None. |
|
| appointmentDate | date |
None. |
|
| filters | Collection of CustomFilterEntity |
None. |
|
| taxFilter | string |
None. |
|
| productId | integer |
None. |
|
| packageId | integer |
None. |
|
| membershipId | integer |
None. |
|
| take | integer |
None. |
|
| orderBy | string |
None. |
|
| membershipCustomerOnly | boolean |
None. |
|
| statusToUpdate | boolean |
None. |
|
| onlyActiveMembership | boolean |
None. |
|
| Id | integer |
None. |
|
| inventoryType | string |
None. |
|
| categoryId | integer |
None. |
|
| brandId | integer |
None. |
|
| templateType | string |
None. |
|
| imageId | integer |
None. |
|
| referenceNo | string |
None. |
|
| smsTemplateType | byte |
None. |
|
| templateCategory | byte |
None. |
Request Formats
application/json, text/json
Sample:
{
"searchKey": "sample string 1",
"billId": 1,
"locationId": 1,
"locationIds": [
1,
2
],
"fromDate": "2025-12-31T16:37:13.6128248+05:30",
"toDate": "2025-12-31T16:37:13.6128248+05:30",
"billDate": "2025-12-31T16:37:13.6128248+05:30",
"vendorId": 1,
"staffId": 1,
"campaignId": 1,
"filterBy": "sample string 5",
"noOfrecords": 6,
"noOfDays": 7,
"filterTime": "sample string 8",
"Services": [
1,
2
],
"memberships": [
1,
2
],
"CustomerName": "sample string 9",
"Mobile": "sample string 10",
"groupBy": "sample string 11",
"customerId": 12,
"activeOnly": true,
"membershipFilter": "sample string 14",
"billItemFilter": [
"sample string 1",
"sample string 2"
],
"appointmentId": 15,
"appointmentStatus": 64,
"comments": "sample string 17",
"reason": "sample string 18",
"startTimeString": "sample string 19",
"endTimeString": "sample string 20",
"appointmentDate": "2025-12-31T16:37:13.6128248+05:30",
"filters": [
{
"FilterId": 1,
"Field": "sample string 2",
"Expression": "sample string 3",
"FilterValue": "sample string 4",
"FilterValueArray": [
1,
2
],
"Condition": "sample string 5",
"VendorId": 6,
"CampaignId": 1,
"Active": true,
"CreatedTime": "2025-12-31T16:37:13.6128248+05:30",
"UpdatedTime": "2025-12-31T16:37:13.6128248+05:30"
},
{
"FilterId": 1,
"Field": "sample string 2",
"Expression": "sample string 3",
"FilterValue": "sample string 4",
"FilterValueArray": [
1,
2
],
"Condition": "sample string 5",
"VendorId": 6,
"CampaignId": 1,
"Active": true,
"CreatedTime": "2025-12-31T16:37:13.6128248+05:30",
"UpdatedTime": "2025-12-31T16:37:13.6128248+05:30"
}
],
"taxFilter": "sample string 22",
"productId": 1,
"packageId": 1,
"membershipId": 1,
"take": 23,
"orderBy": "sample string 24",
"membershipCustomerOnly": true,
"statusToUpdate": true,
"onlyActiveMembership": true,
"Id": 28,
"inventoryType": "sample string 29",
"categoryId": 1,
"brandId": 1,
"templateType": "sample string 30",
"imageId": 31,
"referenceNo": "sample string 32",
"smsTemplateType": 64,
"templateCategory": 64
}
application/xml, text/xml
Sample:
<RequestFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pos_crm_api.Models">
<CustomerName>sample string 9</CustomerName>
<Id>28</Id>
<Mobile>sample string 10</Mobile>
<Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</Services>
<activeOnly>true</activeOnly>
<appointmentDate>2025-12-31T16:37:13.6128248+05:30</appointmentDate>
<appointmentId>15</appointmentId>
<appointmentStatus>64</appointmentStatus>
<billDate>2025-12-31T16:37:13.6128248+05:30</billDate>
<billId>1</billId>
<billItemFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</billItemFilter>
<brandId>1</brandId>
<campaignId>1</campaignId>
<categoryId>1</categoryId>
<comments>sample string 17</comments>
<customerId>12</customerId>
<endTimeString>sample string 20</endTimeString>
<filterBy>sample string 5</filterBy>
<filterTime>sample string 8</filterTime>
<filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/pos_crm_api_DAL.Entities">
<d2p1:CustomFilterEntity>
<d2p1:Active>true</d2p1:Active>
<d2p1:CampaignId>1</d2p1:CampaignId>
<d2p1:Condition>sample string 5</d2p1:Condition>
<d2p1:CreatedTime>2025-12-31T16:37:13.6128248+05:30</d2p1:CreatedTime>
<d2p1:Expression>sample string 3</d2p1:Expression>
<d2p1:Field>sample string 2</d2p1:Field>
<d2p1:FilterId>1</d2p1:FilterId>
<d2p1:FilterValue>sample string 4</d2p1:FilterValue>
<d2p1:FilterValueArray xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d2p1:FilterValueArray>
<d2p1:UpdatedTime>2025-12-31T16:37:13.6128248+05:30</d2p1:UpdatedTime>
<d2p1:VendorId>6</d2p1:VendorId>
</d2p1:CustomFilterEntity>
<d2p1:CustomFilterEntity>
<d2p1:Active>true</d2p1:Active>
<d2p1:CampaignId>1</d2p1:CampaignId>
<d2p1:Condition>sample string 5</d2p1:Condition>
<d2p1:CreatedTime>2025-12-31T16:37:13.6128248+05:30</d2p1:CreatedTime>
<d2p1:Expression>sample string 3</d2p1:Expression>
<d2p1:Field>sample string 2</d2p1:Field>
<d2p1:FilterId>1</d2p1:FilterId>
<d2p1:FilterValue>sample string 4</d2p1:FilterValue>
<d2p1:FilterValueArray xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d2p1:FilterValueArray>
<d2p1:UpdatedTime>2025-12-31T16:37:13.6128248+05:30</d2p1:UpdatedTime>
<d2p1:VendorId>6</d2p1:VendorId>
</d2p1:CustomFilterEntity>
</filters>
<fromDate>2025-12-31T16:37:13.6128248+05:30</fromDate>
<groupBy>sample string 11</groupBy>
<imageId>31</imageId>
<inventoryType>sample string 29</inventoryType>
<locationId>1</locationId>
<locationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</locationIds>
<membershipCustomerOnly>true</membershipCustomerOnly>
<membershipFilter>sample string 14</membershipFilter>
<membershipId>1</membershipId>
<memberships xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</memberships>
<noOfDays>7</noOfDays>
<noOfrecords>6</noOfrecords>
<onlyActiveMembership>true</onlyActiveMembership>
<orderBy>sample string 24</orderBy>
<packageId>1</packageId>
<productId>1</productId>
<reason>sample string 18</reason>
<referenceNo>sample string 32</referenceNo>
<searchKey>sample string 1</searchKey>
<smsTemplateType>64</smsTemplateType>
<staffId>1</staffId>
<startTimeString>sample string 19</startTimeString>
<statusToUpdate>true</statusToUpdate>
<take>23</take>
<taxFilter>sample string 22</taxFilter>
<templateCategory>64</templateCategory>
<templateType>sample string 30</templateType>
<toDate>2025-12-31T16:37:13.6128248+05:30</toDate>
<vendorId>1</vendorId>
</RequestFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |