Differences
This shows you the differences between two versions of the page.
— |
updatecustomerrs [2012/02/17 17:10] (current) admin created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== UpdateCustomerRs (Response) ====== | ||
+ | Posting a proper UpdateCustomerRq request will result in the output of the updated information in a simple print format (read with stdin). The UpdateCustomerRs is the response to the UpdateCustomerRq request and contains the status and all details for the updated / modified customer. | ||
+ | |||
+ | ===== Sample Response: ===== | ||
+ | |||
+ | <code> | ||
+ | <?xml version="1.0" ?> | ||
+ | <F3XML> | ||
+ | <F3XMLRs> | ||
+ | <UpdateCustomerRs RequestID="1"> | ||
+ | <Status>OK</Status> | ||
+ | <Customer> | ||
+ | <CustomerID>150</CustomerID> | ||
+ | <CreationDate>2011-09-20 21:18:09</CreationDate> | ||
+ | <Name>Martha Brady</Name> | ||
+ | <EmailAddress>martha.brady@hotmail.com</EmailAddress> | ||
+ | <Password>GoodLuck23</Password> | ||
+ | <CustomerType>Individual</CustomerType> | ||
+ | <PriceLevel>Retail</PriceLevel> | ||
+ | <TaxExempt>false</TaxExempt> | ||
+ | <TaxID></TaxID> | ||
+ | <URL></URL> | ||
+ | <CustomFields> | ||
+ | <HowDidYouHearOfUs>Magazine Ad</HowDidYouHearOfUs> | ||
+ | </CustomFields> | ||
+ | <BillingAddress> | ||
+ | <Name>Martha Brady</Name> | ||
+ | <Company></Company> | ||
+ | <Addr1>11433 Arvida Rd</Addr1> | ||
+ | <Addr2>11433 Arvida Rd</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> | ||
+ | <Name>Martha Brady</Name> | ||
+ | <Company>The Brady Outlet</Company> | ||
+ | <Addr1>1982 NE 22 Ave</Addr1> | ||
+ | <Addr2></Addr2> | ||
+ | <City>Miami</City> | ||
+ | <State>California</State> | ||
+ | <PostalCode>33122</PostalCode> | ||
+ | <Country>US</Country> | ||
+ | <CommercialAddr>true</CommercialAddr> | ||
+ | <Phone>555-309-2222</Phone> | ||
+ | </ShippingAddress> | ||
+ | </Customer> | ||
+ | </UpdateCustomerRs> | ||
+ | </F3XMLRs> | ||
+ | </F3XML> | ||
+ | </code> | ||
+ | |||
+ | ===== Response Fields ===== | ||
+ | |||
+ | ^ Tag Name ^ Sub-Tag Of ^ Description ^ Returned ^ Field Type ^ Can Repeat ^ | ||
+ | | Status | UpdateCustomerRs | The Request Status | Always | String\\ *OK\\ *Error | False | | ||
+ | | Customer | UpdateCustomerRs | The Customer's Node | Always | Node | True | | ||
+ | | CustomerID | Customer | The Customer ID | Always | Number | False | | ||
+ | | CreationDate | Customer | The Account Creation Date\\ in EST Time Zone (New York) | Always | Date\\ Format: "YYYY-MM-DD hh:mm:ss" \\ Sample: "2011-04-16 12:32:57" | False | | ||
+ | | Name | Customer | The Customer's Name | Always | String | False | | ||
+ | | EmailAddress | Customer | The Customer's Email Address | Always | String | False | | ||
+ | | Password | Customer | The Customer's Account Password | Always | String | False | | ||
+ | | CustomerType | Customer | The Customer Type Field | Always | String:\\ "Individual"\\ "Wholesale"\\ "Corporate"\\ "Education"\\ "Government"\\ "Fortune 1000" | False | | ||
+ | | PriceLevel | Customer | The Customer's Assigned Price Level | Always | String:\\ "Retail"\\ "Price Level 1"\\ "Price Level 2"\\ "Price Level 3"\\ "Price Level 4"\\ "Price Level 5" | False | | ||
+ | | TaxExempt | Customer | Defines if the Customer is Tax Exempt | Always | Boolean:\\ "true"\\ "false" | False | | ||
+ | | TaxID | Customer | The Customer's Federal Tax ID | Always | String | False | | ||
+ | | URL | Customer | The Customer's Website URL | Always | String | False | | ||
+ | | CustomFields | Customer | Node for Custom Checkout Fields\\ in the Final Step | *If Enabled | Node | False | | ||
+ | | $CustomField | Customer->CustomFields | Any Custom Checkout Fields\\ in the Final Step | *If Enabled | String | False | | ||
+ | | BillingAddress | Customer | Node for the Customer's Billing Address | Always | Node | False | | ||
+ | | Name | BillingAddress | The Billing Address Name | Always | String | False | | ||
+ | | Company | BillingAddress | The Billing Address Name | Always | String | False | | ||
+ | | Addr1 | BillingAddress | The Billing Address Line 1| Always | String | False | | ||
+ | | Addr2 | BillingAddress | The Billing Address Line 2 | Always | String | False | | ||
+ | | City | BillingAddress | The Billing Address Ciry | Always | String | False | | ||
+ | | State | BillingAddress | The Billing Address State (Full Name) | Always | String | False | | ||
+ | | PostalCode | BillingAddress | The Billing Address Zip/Postal Code | Always | String | False | | ||
+ | | Country | BillingAddress | The Billing Address Country Code | Always | String | False | | ||
+ | | CommercialAddr | BillingAddress | The Billing Address Commercial Address Indicator | Always | Boolean:\\ "true"\\ "false" | False | | ||
+ | | Phone | BillingAddress | The Billing Address Phone # | Always | String | False | | ||
+ | | CompanyPhone | BillingAddress | The Billing Address Company Phone # | Always | String | False | | ||
+ | | Fax | BillingAddress | The Billing Address Fax # | Always | String | False | | ||
+ | | CustomFields | BillingAddress | Node for Custom Checkout Fields\\ in the Billing Address | *If Enabled | Node | False | | ||
+ | | $CustomField | BillingAddress->CustomFields | Any Custom Checkout Fields\\ in the Billing Address | *If Enabled | String | False | | ||
+ | | ShippingAddress | Customer | Node for the Customer's Shipping Address | Always | Node | False | | ||
+ | | Name | ShippingAddress | The Shipping Address Name | Always | String | False | | ||
+ | | Company | ShippingAddress | The Shipping Address Name | Always | String | False | | ||
+ | | Addr1 | ShippingAddress | The Shipping Address Line 1| Always | String | False | | ||
+ | | Addr2 | ShippingAddress | The Shipping Address Line 2 | Always | String | False | | ||
+ | | City | ShippingAddress | The Shipping Address Ciry | Always | String | False | | ||
+ | | State | ShippingAddress | The Shipping Address State (Full Name) | Always | String | False | | ||
+ | | PostalCode | ShippingAddress | The Shipping Address Zip/Postal Code | Always | String | False | | ||
+ | | Country | ShippingAddress | The Shipping Address Country Code | Always | String | False | | ||
+ | | CommercialAddr | ShippingAddress | The Shipping Address Commercial Address Indicator | Always | Boolean:\\ "true"\\ "false" | False | | ||
+ | | Phone | ShippingAddress | The Shipping Address Phone # | Always | String | False | | ||
+ | | CustomFields | ShippingAddress | Node for Custom Checkout Fields\\ in the Shipping Address | *If Enabled | Node | False | | ||
+ | | $CustomField | ShippingAddress->CustomFields | Any Custom Checkout Fields\\ in the Shipping Address | *If Enabled | String | False | |