Customers

From DevWiki

Jump to: navigation, search

Customers Info

Custom Fields

If Custom Fields are modified for customers or orders, you must do the following to have access to those fields via the API:

The store owner must FTP into their store and go to the /vspfiles/schema/ directory and delete the files named Customers.xsd and/or Orders.xsd. Once the appropriate file is deleted, the next time the API is called it will generate the necessary XSD file with the new Custom Field information. If this step is not done the API will have no access to those columns.

Customers XSD

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="xmldata" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:msprop="urn:schemas-microsoft-com:xml-msprop">
	<xs:element name="xmldata" msdata:IsDataSet="true" msdata:UseCurrentLocale="true">
		<xs:complexType>
			<xs:choice minOccurs="0" maxOccurs="unbounded">
				<xs:element name="Customers">
					<xs:complexType>
						<xs:sequence>
							<xs:element minOccurs="0" msprop:SqlDbType="Int" msprop:IsIdentity="true" name="CustomerID" msprop:TableNameXsd="Customers" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="AccessKey" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Allow_Access_To_Private_Sections" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="BillingAddress1" msprop:maxLength="75" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="BillingAddress2" msprop:maxLength="75" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="CatalogSubscriber" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Checkbox_For_New_Customers" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="City" msprop:maxLength="45" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="CompanyName" msprop:maxLength="100" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Country" msprop:maxLength="30" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Custom_Field_Custom1" msprop:maxLength="50" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Custom_Field_Custom2" msprop:maxLength="50" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Custom_Field_Custom3" msprop:maxLength="50" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Custom_Field_Custom4" msprop:maxLength="50" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Custom_Field_Custom5" msprop:maxLength="50" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Customer_IsAnonymous" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="Text" name="Customer_Notes" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="CustomerType" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="DiscountLevel" msprop:maxLength="1" />
							<xs:element minOccurs="1" msprop:SqlDbType="VarChar" name="EmailAddress" msprop:maxLength="75" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="EmailSubscriber" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="FaxNumber" msprop:maxLength="30" />
							<xs:element minOccurs="0" msprop:SqlDbType="SmallDateTime" name="FirstDateVisited" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="FirstName" msprop:maxLength="50" />
							<xs:element minOccurs="0" msprop:SqlDbType="SmallDateTime" name="FirstOrderDate" />
							<xs:element minOccurs="0" msprop:SqlDbType="Int" name="ID_Customers_Groups" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="IsSuperAdmin" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="SmallDateTime" name="LastLogin" />
							<xs:element minOccurs="0" msprop:SqlDbType="SmallDateTime" name="LastLoginAttempt" />
							<xs:element minOccurs="0" msprop:SqlDbType="Int" name="LastModBy" />
							<xs:element minOccurs="0" msprop:SqlDbType="SmallDateTime" name="LastModified" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="LastName" msprop:maxLength="50" />
							<xs:element minOccurs="0" msprop:SqlDbType="Int" name="LoginAttempts" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news1" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news10" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news11" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news12" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news13" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news14" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news15" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news16" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news17" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news18" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news19" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news2" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news20" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news3" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news4" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news5" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news6" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news7" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news8" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="news9" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Password" msprop:maxLength="64" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="PaysStateTax" msprop:maxLength="3" />
							<xs:element minOccurs="0" msprop:SqlDbType="Float" name="PercentDiscount" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="PhoneNumber" msprop:maxLength="35" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="PostalCode" msprop:maxLength="15" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="Removed_From_Rewards" msprop:maxLength="1" />
							<xs:element minOccurs="0" msprop:SqlDbType="Int" name="SalesRep_CustomerID" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="State" msprop:maxLength="30" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="TaxID" msprop:maxLength="64" />
							<xs:element minOccurs="0" msprop:SqlDbType="VarChar" name="WebsiteAddress" msprop:maxLength="150" />
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:choice>
		</xs:complexType>
	</xs:element>
</xs:schema>

Sample XML

Navigation