header

Magento 1.x Software Support Notice

For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.

For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business.

Customer Addresses

Mage_Checkout

Module: Shopping Cart API

Resource: cart_customer

Method:

Allows you to set the customer addresses in the shopping cart (quote).

Arguments:

Type Name Description
string sessionId Session ID
int quoteId Shopping cart ID
array customerAddressData Array of shoppingCartCustomerAddressEntity
string store Store view ID or code (optional)

Return:

Type Name Description
boolean result True if the address is set

The shoppingCartCustomerAddressEntity content is as follows:

Type Name Description
string mode
Mode: billing or shipping
string
address_id
Address ID
string
firstname
Customer first name
string
lastname
Customer last name
string
company
Company name
string
street
Street
string
city
City
string
region
Region
string
region_id
Region ID
string
postcode
Post code
string
country_id
Country ID
string
telephone
Telephone number
string
fax
Fax number
int is_default_billing
Defines whether the address is a default billing address
int is_default_shipping
Defines whether the address is a default shipping address

Faults:
No Faults.

Examples

Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');

$shoppingCartId = $proxy->call( $sessionId, 'cart.create', array( 'magento_store' ) );

$arrAddresses = array(
	array(
		"mode" => "shipping",
		"firstname" => "testFirstname",
		"lastname" => "testLastname",
		"company" => "testCompany",
		"street" => "testStreet",
		"city" => "testCity",
		"region" => "testRegion",
		"postcode" => "testPostcode",
		"country_id" => "id",
		"telephone" => "0123456789",
		"fax" => "0123456789",
		"is_default_shipping" => 0,
		"is_default_billing" => 0
	),
	array(
		"mode" => "billing",
		"address_id" => "customer_address_id"
	)
);

$resultCustomerAddresses = $proxy->call(
	$sessionId,
	"cart_customer.addresses",
	array(
		$shoppingCartId,
		$arrAddresses,
	)
);
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 
 
$sessionId = $proxy->login('apiUser', 'apiKey'); 
  
$result = $proxy->shoppingCartCustomerAddresses($sessionId, 10, array(array(
'mode' => 'billing',
'firstname' => 'first name',
'lastname' => 'last name',
'street' => 'street address',
'city' => 'city',
'region' => 'region',
'postcode' => 'postcode',
'country_id' => 'US',
'telephone' => '123456789',
'is_default_billing' => 1
)));   
var_dump($result);
Request Example SOAP V2 (WS-I Compliance Mode)
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

$sessionId = $proxy->login((object)array('username' => 'apiUser', 'apiKey' => 'apiKey'));

$result = $proxy->shoppingCartCustomerAddresses((object)array('sessionId' => $sessionId->result, 'quoteId' => 10, 'customerAddressData' => array(array(
'mode' => 'billing',
'firstname' => 'first name',
'lastname' => 'last name',
'street' => 'street address',
'city' => 'city',
'region' => 'region',
'postcode' => 'postcode',
'country_id' => 'US',
'telephone' => '123456789',
'is_default_billing' => 1
))));
var_dump($result->result);