Customer Server

The Customer Server web service provides several Web methods for interacting with customers.

For SOLO Server Shared URL, this can be reached at https://secure.softwarekey.com/solo/webservices/customerserver.asmx

Please contact us if you need assistance determining the correct URL.

The customerserver.asmx web service offers the following methods:

CreateCustomer

Creates a new customer or modifies an existing customer with the same email/password combination.

This method requires passing in a SOLO Server AuthorID/API UserID/API UserPassword, and the user must have the Add Single Customer permission.

Important

Since this web method requires providing an AuthorID, API UserID, and API User Password as inputs, it should be used for internal applications only and should not be called by client applications distributed to customers. See web service security for details.

If you are currently using regular UserID and UserPassword credentials, you will need to update your application(s) to use an API UserID and API UserPassword instead, as support for the regular User ID and Password will be removed in the future.

Important

The optional fields listed below are considered optional in the SOLO Server database. Specifying a blank value will result in the respective field being updated with an empty value in the database.

Input

Parameter Data Type Required/Optional Description
authorID int Required SOLO Server Author ID.
userID string Required The API User ID of the user from the given author using the service (previously the regular User ID). The API User ID and Password need to be used, as support for the regular User ID and Password will be removed in the future.
userPassword string Required The API User Password for API User ID (previously the regular User Password for the User ID). The API User ID and Password need to be used, as support for the regular User ID and Password will be removed in the future.
companyName string Optional The name of the customer's company. Pass in an empty string if a company name has not been specified or is otherwise unavailable.
firstName string Optional The customer's first name.
lastName string Optional The customer's last name.
address1 string Optional The customer's address, line #1.
address2 string Optional The customer's address, line #2. Pass in an empty string if a second address line has not been specified or is otherwise unavailable.
city string Optional The customer's city.
stateProvince string Optional The customer state/province. For US and Canadian addresses, this should be validated to be a valid state/province code. See State Codes and Country Strings as well as Client Validation Script for details on validation.
postalCode string Optional The customer postal code. For US and Canadian addresses, this should be validated to be a valid postal code. See State Codes and Country Strings as well as Client Validation Script for details on validation.
country string Optional The customer's country. This should be a valid SOLO Server country string. See State Codes and Country Strings as well as Client Validation Script for details on validation.
email string Optional The customer's e-mail address.
password string Optional The new customer password. Pass in an empty string to generate a random password.
phone string Optional The customer's phone number. Pass in an empty string if a phone number has not been specified or is otherwise unavailable.
fax string Optional The customer's fax number. Pass in an empty string if a fax number has not been specified or is otherwise unavailable.
nickname string Optional The customer's external reference. The external reference field on the customer was previously the nickname field, and the parameter name in this method has been left unchanged to preserve backwards compatibility with existing integrations.
offerProduct string Required Pass in True to sign-up the customer for receipt of product e-mails; otherwise, pass in False.
offerPartners string Required Pass in True to sign-up the customer for receipt of partner e-mails; otherwise, pass in False.

Output

The result DataSet contains the following parameters:

Parameter Data Type Description
Failure
ResultCode int The result code could be:
  • -1 - The Author ID, User ID, and user password combination is invalid, or the user account does not have proper permissions to add customer records.
Sucess
CustomerID int The Customer ID is returned when all the input values are valid and a customer is created.