Table of Contents

AddCustomerRq (Request)

The AddCustomerRq request allows users to create customer accounts in the Fortune3 database. It can be used to do a mass import of customer accounts and their addresses into the ecommerce database, or to create a single customer account.

Creating Customer Accounts

In order to create an account you will need to provide all required fields. You may also import any optional customer account fields and/or custom checkout fields you have added to the billing or shipping address. Proceed as Follows:

Sample Code (creating customer account with Email “martha.brady@hotmail.com”): 

<sendRequestXML>
<authenticate>
<APIUsername>TWmY6WBft</APIUsername>
<APIPassword>SKW8ssAmDu6xTGDl</APIPassword>
</authenticate>
<AddCustomerRq RequestID="1">
	<Customer>
		<EmailAddress>martha.brady@hotmail.com</EmailAddress>
		<Password>GoodLuck23</Password>
		<CustomerFName>Martha</CustomerFName>
   		<CustomerLName>Brady</CustomerLName>
		<BillingAddress>
			<CustomerLName>Brady</CustomerLName>
			<CustomerFName>Martha</CustomerFName>
			<Addr1>11433 Arvida Rd</Addr1>
			<Addr2>Unit 203</Addr2>
			<City>Hollywood</City>
			<State>California</State>
			<PostalCode>90208</PostalCode>
			<Country>US</Country>
			<CommercialAddr>false</CommercialAddr>
			<Phone>555-309-2222</Phone>
			<CompanyPhone>555-908-2212</CompanyPhone>
			<Fax>555-908-2213</Fax>
		</BillingAddress>
		<ShippingAddress>
			<CustomerLName>Brady</CustomerLName>
			<CustomerFName>Martha</CustomerFName>
			<Company>The Brady Outlet</Company>
			<Addr1>1982 NE 22 Ave</Addr1>
			<Addr2></Addr2>
			<City>Miami</City>
			<State>Florida</State>
			<PostalCode>33122</PostalCode>
			<Country>US</Country>
			<CommercialAddr>true</CommercialAddr>
			<Phone>555-309-2222</Phone>
		</ShippingAddress>
	</Customer>
</AddCustomerRq>
</sendRequestXML>

Available Fields for AddCustomerRq

Tag Name Sub-Tag Of Description Field Type Is Required
Customer AddCustomerRq The Customer Account Node Node True
EmailAddress Customer The Customer's Email Address (or username) String
Max: 250 Characters 		True
Password Customer The Customer's Account Password String
Min: 5 Characters
Max: 30 Characters 		Only if CustomerType = Wholesale
CustomerFName Customer The Customer's First Name String
Max: 100 Characters 		True
CustomerLName Customer The Customer's Last Name String
Max: 100 Characters 		True
CustomerMName Customer The Customer's Middle Name Initial String
Max: 50 Characters 		False
CustomerType Customer The Customer Account Type String:
* Individual
* Corporate
* Education
* Government
* Fortune 1000
* Wholesale 		False
(Default: Individual)
PriceLevel Customer The Customer's Price Level String:
* Retail
* Price Level 1
* Price Level 2
* Price Level 3
* Price Level 4
* Price Level 5 		False
(Default: Retail)
TaxExempt Customer Defines if the Customer is Tax Exempt Boolean
* true
* false 		False
(Default: false)
TaxID Customer The Customer's Federal Tax ID String
Max: 16 Characters 		False
URL Customer The Customer's Website URL String
Max: 50 Characters 		False
CustomFields Customer Node for Custom Checkout Fields
in the Final Step 		Node False
$CustomField CustomFields Any Custom Checkout Fields
in the Final Step 		String
(Must Match Existing Custom Field
Name on store's Final Step) 		False
BillingAddress Customer The Billing Address Node Node False
CustomerFName BillingAddress The Billing Address First Name String
Max: 100 Characters 		True
*(If BillingAddress Node Present)
CustomerLName BillingAddress The Billing Address Last Name String
Max: 100 Characters 		True
*(If BillingAddress Node Present)
CustomerMName BillingAddress The Billing Address Middle Name Initial String
Max: 50 Characters 		False
Company BillingAddress The Billing Address Company Name String
Max: 25 Characters 		False
Addr1 BillingAddress The Billing Address Line 1 String
Max: 60 Characters 		True
*(If BillingAddress Node Present)
Addr2 BillingAddress The Billing Address Line 2 String
Max: 60 Characters 		False
City BillingAddress The Billing Address City String
Max: 40 Characters 		True
*(If BillingAddress Node Present)
State BillingAddress The Billing Address State String
(Use the full state/province name or the 2-Letter state code for US and Canada) 		True
*(If BillingAddress Node Present)
PostalCode BillingAddress The Billing Address Zip/Postal Code String True
*(If BillingAddress Node Present)
Country BillingAddress The Billing Address Country String
(Use the full country name or the 2-Letter country code) 		True
*(If BillingAddress Node Present)
CommercialAddr BillingAddress Defines if the Billing Address is a Commercial Address Boolean
* true
* false 		False
(Default: false)
Phone BillingAddress The Billing Address Phone Number String
Max: 22 Characters 		False
CompanyPhone BillingAddress The Billing Address Company Phone Number String
Max: 22 Characters 		False
Fax BillingAddress The Billing Address Fax Number String
Max: 22 Characters 		False
CustomFields BillingAddress Node for Custom Checkout Fields
in the Billing Address 		Node False
$CustomField BillingAddress→CustomFields Any Custom Checkout Fields
in the Billing Address 		String
(Must Match Existing Custom Field
Name on store's Billing Address) 		False
ShippingAddress Customer The Shipping Address Node Node False
CustomerFName ShippingAddress The Shipping Address First Name String
Max: 100 Characters 		True
*(If ShippingAddress Node Present)
CustomerLName ShippingAddress The Shipping Address Last Name String
Max: 100 Characters 		True
*(If ShippingAddress Node Present)
CustomerMName ShippingAddress The Shipping Address Middle Name Initial String
Max: 50 Characters 		False
Company ShippingAddress The Shipping Address Company Name String
Max: 25 Characters 		False
Addr1 ShippingAddress The Shipping Address Line 1 String
Max: 60 Characters 		True
*(If ShippingAddress Node Present)
Addr2 ShippingAddress The Shipping Address Line 2 String
Max: 60 Characters 		False
City ShippingAddress The Shipping Address City String
Max: 40 Characters 		True
*(If ShippingAddress Node Present)
State ShippingAddress The Shipping Address State String
(Use the full state/province name or the 2-Letter state code for US and Canada) 		True
*(If ShippingAddress Node Present)
PostalCode ShippingAddress The Shipping Address Zip/Postal Code String True
*(If ShippingAddress Node Present)
Country ShippingAddress The Shipping Address Country String
(Use the full country name or the 2-Letter country code) 		True
*(If ShippingAddress Node Present)
CommercialAddr ShippingAddress Defines if the Shipping Address is a Commercial Address Boolean
* true
* false 		False
(Default: false)
Phone ShippingAddress The Shipping Address Phone Number String
Max: 22 Characters 		False
CustomFields ShippingAddress Node for Custom Checkout Fields
in the Shipping Address 		Node False
$CustomField ShippingAddress→CustomFields Any Custom Checkout Fields
in the Shipping Address 		String
(Must Match Existing Custom Field
Name on store's Shipping Address) 		False

Sample Code 2 (creating a wholesale customer account with Email “martha.brady@hotmail.com”, all possible fields submitted): 

<sendRequestXML>
<authenticate>
<APIUsername>TWmY6WBft</APIUsername>
<APIPassword>SKW8ssAmDu6xTGDl</APIPassword>
</authenticate>
<AddCustomerRq RequestID="1">
	<Customer>
		<EmailAddress>martha.brady@hotmail.com</EmailAddress>
		<Password>GoodLuck23</Password>
		<CustomerFName>Martha</CustomerFName>
   		<CustomerLName>Brady</CustomerLName>
		<CustomerMName>H</CustomerMName>
		<CustomerType>Wholesale</CustomerType>
		<PriceLevel>Price Level 1</PriceLevel>
		<TaxExempt>true</TaxExempt>
		<TaxID>95-1111989</TaxID>
		<URL>http://www.thebradyoutlet.com</URL>
		<CustomFields>
			<HowDidYouHearOfUs>Magazine Ad</HowDidYouHearOfUs>
		</CustomFields>
		<BillingAddress>
			<CustomerLName>Brady</CustomerLName>
			<CustomerFName>Martha</CustomerFName>
			<CustomerMName>H</CustomerMName>
			<Company></Company>
			<Addr1>11433 Arvida Rd</Addr1>
			<Addr2>Unit 203</Addr2>
			<City>Hollywood</City>
			<State>California</State>
			<PostalCode>90208</PostalCode>
			<Country>US</Country>
			<CommercialAddr>false</CommercialAddr>
			<Phone>555-309-2222</Phone>
			<CompanyPhone>555-908-2212</CompanyPhone>
			<Fax>555-908-2213</Fax>
			<CustomFields>
				<CellPhoneNumber>555-221-1221</CellPhoneNumber>
				<BestTimeToCall>Morning</BestTimeToCall>
			</CustomFields>
		</BillingAddress>
		<ShippingAddress>
			<CustomerLName>Brady</CustomerLName>
			<CustomerFName>Martha</CustomerFName>
			<CustomerMName>H</CustomerMName>
			<Company>The Brady Outlet</Company>
			<Addr1>1982 NE 22 Ave</Addr1>
			<Addr2></Addr2>
			<City>Miami</City>
			<State>Florida</State>
			<PostalCode>33122</PostalCode>
			<Country>US</Country>
			<CommercialAddr>true</CommercialAddr>
			<Phone>555-309-2222</Phone>
		</ShippingAddress>
	</Customer>
</AddCustomerRq>
</sendRequestXML>

Next: Reading the Response (AddCustomerRs)

Print/export