--- layout: m1x_soap title: Shipping List ---

Mage_Checkout

Module: Shopping Cart API

Resource: cart_shipping

Method:

cart_shipping.list (SOAP V1)
shoppingCartShippingList (SOAP V2)

Allows you to retrieve the list of available shipping methods for a shopping cart (quote).

Arguments:

Type	Name	Description
string	sessionId	Session ID
int	quoteId	Shopping cart ID
string	store	Store view ID or code (optional)

Returns:

Type	Name	Description
array	result	Array of shoppingCartShippingMethodEntity

The shoppingCartShippingMethodEntity content is as follows:

Type	Name	Description
string	code	Code
string	carrier	Carrier
string	carrier_title	Carrier title
string	method	Shipping method
string	method_title	Shipping method title
string	method_description	Shipping method description
double	price	Shipping price

Faults:
No Faults.

Examples

Request Example SOAP V1

		$proxy = new SoapClient('http://magentohost/api/soap/?wsdl'); 

$sessionId = $proxy->login('apiUser', 'apiKey'); 
 
$result = $proxy->call($sessionId, 'cart_shipping.list', 10);   

var_dump($result);

Request Example SOAP V2

		$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy->login('apiUser', 'apiKey'); 
 
$result = $proxy->shoppingCartShippingList($sessionId, 10);   

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->shoppingCartShippingList((object)array('sessionId' => $sessionId->result, 'quoteId' => 10));   
var_dump($result->result);