com.ibm.commerce.tools.optools.order.commands
Interface CSRCustomerAddressAddCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
- All Known Implementing Classes:
- CSRCustomerAddressAddCmdImpl
- public interface CSRCustomerAddressAddCmd
- extends ToolsControllerCommand
Create a new address for the customer by calling AddressUpdateCmd.
URL calling syntax:
Https://host_name/path/CSRCustomerAddressAdd?XML=xml_string&URL=return_url
Parameters:
XML
An input xml_string that contains the all required data for creating the new address for the customer.
Example xml_string:
<?xml version="1.0" encoding "UTF-8">
<order>
<customerId>20000</customerId>
</order>
<address>
<addrType>SB</addrType>
<nickName>Home</nickName>
<lastName>ABC</lastName>
<firstName>XYZ</firstName>
<address1>8200 Warden Ave.</address1>
<address2>A3 - 999</address2>
<city>Markham</city>
<region>Ontario</region>
<country>Canada</country>
<postalCode>L3N 3R6</postalCode>
<phoneNumber>905-413-1234</phoneNumber>
<email>abc@mail.com</email>
</address>
</xml>
URL
The URL to be called when the command completes successfully.
Response Parameters:
addressId
Return the address ID for the customer
Exceptions:
Based on Locale/Language, some fields for the address creation are required.
Once missing, this command will throw exception to indicate which field is
missing and specify the CSRCustomerAddressAddErrorView error view command.
Method Summary |
java.lang.String |
getAddressId()
Return address ID. |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
defaultCommandClassName
public static final java.lang.String defaultCommandClassName
- The default implementation class name.
NAME
public static final java.lang.String NAME
getAddressId
public java.lang.String getAddressId()
- Return address ID.
The address ID also appends to success redirect URL.
- Returns:
- java.lang.String