POST api/customers

Add or update Customer(s). Search customer by Email or Customer Code or Cell Phone and update if found, otherwise add new. State and Country defined by code or name, note type defined by name. Dob format: yyyy-mm-dd. For adding only (not for update): you can setup (by default - false) which field should be required (do not allow to add customer when can't resolve these fields by names or they was not set), by these properties: RequireCountry, RequireState, RequireDob, RequireNote (if note type was not set or can't be resolved - do not add customer), RequireGender (if gender was not set correctly - do not add customer, otherwise use default Unknown gender).

Request Information

Allows multi-location processing, in case of using parent location token restrictByLocations parameter is strongly recommended with comma separated list of locations to select from or update in

URI Parameters

None.

Body Parameters

List of Customers

CustomersModel

Name	Type	Additional information
RequireCountry	boolean	None.
RequireState	boolean	None.
RequireDob	boolean	None.
RequireNote	boolean	None.
RequireGender	boolean	None.
IgnoreSharedCustomers	boolean	None.
Customers	Collection of CustomerInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "RequireCountry": true,
  "RequireState": true,
  "RequireDob": true,
  "RequireNote": true,
  "RequireGender": true,
  "IgnoreSharedCustomers": true,
  "Customers": [
    {
      "LocationId": 1,
      "CustomerId": 2,
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Email": "sample string 5",
      "CellPhone": "sample string 6",
      "WorkPhone": "sample string 7",
      "Dob": "2024-10-18T01:16:57.8984692-04:00",
      "Gender": 1,
      "CustomerCode": "sample string 8",
      "Address": "sample string 9",
      "Address2": "sample string 10",
      "City": "sample string 11",
      "Zip": "sample string 12",
      "Country": "sample string 13",
      "State": "sample string 14",
      "NoteType": "sample string 15",
      "Notes": "sample string 16",
      "Balance": 1.0,
      "RewardPoints": 1.0,
      "Image": "sample string 17",
      "NopExternalId": "sample string 18",
      "LeadSourceId": 1
    },
    {
      "LocationId": 1,
      "CustomerId": 2,
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Email": "sample string 5",
      "CellPhone": "sample string 6",
      "WorkPhone": "sample string 7",
      "Dob": "2024-10-18T01:16:57.8984692-04:00",
      "Gender": 1,
      "CustomerCode": "sample string 8",
      "Address": "sample string 9",
      "Address2": "sample string 10",
      "City": "sample string 11",
      "Zip": "sample string 12",
      "Country": "sample string 13",
      "State": "sample string 14",
      "NoteType": "sample string 15",
      "Notes": "sample string 16",
      "Balance": 1.0,
      "RewardPoints": 1.0,
      "Image": "sample string 17",
      "NopExternalId": "sample string 18",
      "LeadSourceId": 1
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

list of results in format: [LocationId], [FirstName], [LastName], [Email], [CustomerCode], [CellPhone], [Dob], [Status]. If Status is "Error" - there was inner error, it will be put into Message field. Otherwise it show "Added" / "Updated" - customer was added or updated

HttpResponseMessage

Name	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.