POST api/Customers/Search

Search the Customer File and return all matching record(s). (Maximum 250)

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.CustomerSearchArguments

Name	Description	Type	Additional information
EmailAddress	The customer's email address	string	String length: inclusive between 0 and 100
Name	The Customer's name. The formatting of this can be controlled within the Eskimo software.	string	String length: inclusive between 0 and 250
Address	The main invoice address of the customer.	string	String length: inclusive between 0 and 400
PostCode	Post/Zip code for the customer's invoice address.	string	String length: inclusive between 0 and 16
CompanyName	Company Name, if applicable	string	String length: inclusive between 0 and 60
Phone	Customer's Contact Numbers. Will search both Telephone and Mobile fields.	string	String length: inclusive between 0 and 70
AccountID	Will search both the Eskimo Customer ID and the External ID.	string	String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

{
  "EmailAddress": "sample string 1",
  "Name": "sample string 2",
  "Address": "sample string 3",
  "PostCode": "sample string 4",
  "CompanyName": "sample string 5",
  "Phone": "sample string 6",
  "AccountID": "sample string 7"
}

application/xml, text/xml

Sample:

<CustomerSearchArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <AccountID>sample string 7</AccountID>
  <Address>sample string 3</Address>
  <CompanyName>sample string 5</CompanyName>
  <EmailAddress>sample string 1</EmailAddress>
  <Name>sample string 2</Name>
  <Phone>sample string 6</Phone>
  <PostCode>sample string 4</PostCode>
</CustomerSearchArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsCustomer

Name	Description	Type	Additional information
ID	The unique ID of the customer. This is in the format 000-000000 where the first three digits represent the Shop/Showroom code. This only needs to be specified when updating a record, not when creating.	string	Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10
Forename	Customer's first name(s)	string	String length: inclusive between 0 and 50
Surname	Customer's surname	string	String length: inclusive between 0 and 50
CompanyName	The Company Name	string	String length: inclusive between 0 and 60
MarketingFlagsID	A collection of the marketing flag IDs that the customer has opted in for (GDPR). See api/Customers/MarketingFlags	Collection of integer	None.
AccountBalance	Used either for saving schemes/customer accounts, this is the customer's current balance.	decimal number	None.
CustomerType	The type of customer.	EskimoClassLibraries.clsCustomer+CustomerTypeEnum	None.
ShopVisibility	Which shops can see this customer.	EskimoClassLibraries.clsShopVisibility	None.
ShopCreatedBy	Optional. If omitted, this will default to the database the API is connected to, but can be specified.	string	None.
PriceListID	Readonly. If using Price Lists, this determines which one the customer is linked to. See api/TillMenu/PriceListDump	integer	None.
PriceLevel	Readonly. If not using Price Lists, this determines which price level to use for the customer.	integer	None.
AutomaticDiscountPercentage	Readonly. Some customers are setup to benefit from a blanket discount on all products. This is the percentage	integer	None.
Notes	Any notes about the customer. These can also be edited in the Eskimo software so may NOT be suitable for presenting to end-users.	string	None.
Telephone	Customer's telephone number	string	String length: inclusive between 0 and 70
Mobile	Customer's mobile number	string	String length: inclusive between 0 and 70
EmailAddress	The email address of the customer. This is not the unique identifier in the Eskimo software - there may be duplicates although you will not be able to insert a new customer if that email address already exists.	string	String length: inclusive between 0 and 100
WebsiteAddress	The domain of the customer's website	string	String length: inclusive between 0 and 100
ActiveAccount	Current active status of the customer. (On/Off)	boolean	Required
Address	Customer's Address minus the postal code. Carriage returns can be specified in JSON with a simple \r\n (i.e. "Address": "123 High Street\r\nLondon" )	string	String length: inclusive between 0 and 400
PostCode	Customer's postal code	string	String length: inclusive between 0 and 16
TitleID	ID of the Customer's title (i.e. Mr., Mrs., Ms.) Use TitleID from api/Customers/Titles	integer	None.
CountryCode	The 2 digit country code, for United Kingdon, use GB http://www.worldatlas.com/aatlas/ctycodes.htm	string	Required String length: inclusive between 2 and 2
ExternalID	Non-Eskimo Identifier. If this customer has also been inserted into another CRM system or Website, this is the PK for this customer entry.	string	String length: inclusive between 0 and 50
MainAddress	Required if running a multiple-addresses per customer system. If running a single address per customer system, use the Address and Postcode fields.	EskimoClassLibraries.clsAddress	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "CompanyName": "sample string 4",
    "MarketingFlagsID": [
      1,
      2
    ],
    "AccountBalance": 1.0,
    "CustomerType": 0,
    "ShopVisibility": {
      "VisibleEverywhere": true,
      "ShopIDs": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "ShopCreatedBy": "sample string 5",
    "PriceListID": null,
    "PriceLevel": 1,
    "AutomaticDiscountPercentage": 0,
    "Notes": "sample string 6",
    "Telephone": "sample string 7",
    "Mobile": "sample string 8",
    "EmailAddress": "sample string 9",
    "WebsiteAddress": "sample string 10",
    "ActiveAccount": true,
    "Address": "sample string 12",
    "PostCode": "sample string 13",
    "TitleID": 1,
    "CountryCode": "sample string 14",
    "ExternalID": "sample string 15",
    "MainAddress": {
      "Company": "sample string 1",
      "Line1": "sample string 2",
      "Line2": "sample string 3",
      "Line3": "sample string 4",
      "PostalTown": "sample string 5",
      "Region": "sample string 6",
      "PostCode": "sample string 7",
      "CountryCode": "sample string 8",
      "Active": true
    }
  },
  {
    "ID": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "CompanyName": "sample string 4",
    "MarketingFlagsID": [
      1,
      2
    ],
    "AccountBalance": 1.0,
    "CustomerType": 0,
    "ShopVisibility": {
      "VisibleEverywhere": true,
      "ShopIDs": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "ShopCreatedBy": "sample string 5",
    "PriceListID": null,
    "PriceLevel": 1,
    "AutomaticDiscountPercentage": 0,
    "Notes": "sample string 6",
    "Telephone": "sample string 7",
    "Mobile": "sample string 8",
    "EmailAddress": "sample string 9",
    "WebsiteAddress": "sample string 10",
    "ActiveAccount": true,
    "Address": "sample string 12",
    "PostCode": "sample string 13",
    "TitleID": 1,
    "CountryCode": "sample string 14",
    "ExternalID": "sample string 15",
    "MainAddress": {
      "Company": "sample string 1",
      "Line1": "sample string 2",
      "Line2": "sample string 3",
      "Line3": "sample string 4",
      "PostalTown": "sample string 5",
      "Region": "sample string 6",
      "PostCode": "sample string 7",
      "CountryCode": "sample string 8",
      "Active": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsCustomer>
    <AccountBalance>1</AccountBalance>
    <ActiveAccount>true</ActiveAccount>
    <Address>sample string 12</Address>
    <CompanyName>sample string 4</CompanyName>
    <CountryCode>sample string 14</CountryCode>
    <CustomerType>TradeCustomer</CustomerType>
    <EmailAddress>sample string 9</EmailAddress>
    <ExternalID>sample string 15</ExternalID>
    <Forename>sample string 2</Forename>
    <ID>sample string 1</ID>
    <MainAddress>
      <Active>true</Active>
      <Company>sample string 1</Company>
      <CountryCode>sample string 8</CountryCode>
      <Line1>sample string 2</Line1>
      <Line2>sample string 3</Line2>
      <Line3>sample string 4</Line3>
      <PostCode>sample string 7</PostCode>
      <PostalTown>sample string 5</PostalTown>
      <Region>sample string 6</Region>
    </MainAddress>
    <MarketingFlagsID xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MarketingFlagsID>
    <Mobile>sample string 8</Mobile>
    <Notes>sample string 6</Notes>
    <PostCode>sample string 13</PostCode>
    <ShopCreatedBy>sample string 5</ShopCreatedBy>
    <ShopVisibility>
      <ShopIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ShopIDs>
      <VisibleEverywhere>true</VisibleEverywhere>
    </ShopVisibility>
    <Surname>sample string 3</Surname>
    <Telephone>sample string 7</Telephone>
    <TitleID>1</TitleID>
    <WebsiteAddress>sample string 10</WebsiteAddress>
  </clsCustomer>
  <clsCustomer>
    <AccountBalance>1</AccountBalance>
    <ActiveAccount>true</ActiveAccount>
    <Address>sample string 12</Address>
    <CompanyName>sample string 4</CompanyName>
    <CountryCode>sample string 14</CountryCode>
    <CustomerType>TradeCustomer</CustomerType>
    <EmailAddress>sample string 9</EmailAddress>
    <ExternalID>sample string 15</ExternalID>
    <Forename>sample string 2</Forename>
    <ID>sample string 1</ID>
    <MainAddress>
      <Active>true</Active>
      <Company>sample string 1</Company>
      <CountryCode>sample string 8</CountryCode>
      <Line1>sample string 2</Line1>
      <Line2>sample string 3</Line2>
      <Line3>sample string 4</Line3>
      <PostCode>sample string 7</PostCode>
      <PostalTown>sample string 5</PostalTown>
      <Region>sample string 6</Region>
    </MainAddress>
    <MarketingFlagsID xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MarketingFlagsID>
    <Mobile>sample string 8</Mobile>
    <Notes>sample string 6</Notes>
    <PostCode>sample string 13</PostCode>
    <ShopCreatedBy>sample string 5</ShopCreatedBy>
    <ShopVisibility>
      <ShopIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ShopIDs>
      <VisibleEverywhere>true</VisibleEverywhere>
    </ShopVisibility>
    <Surname>sample string 3</Surname>
    <Telephone>sample string 7</Telephone>
    <TitleID>1</TitleID>
    <WebsiteAddress>sample string 10</WebsiteAddress>
  </clsCustomer>
</ArrayOfclsCustomer>