Mage_Checkout
Module: Shopping Cart API
Resource: cart_shipping
Method:
- cart_shipping.method (SOAP V1)
- shoppingCartShippingMethod (SOAP V2)
Allows you to set a shipping method for a shopping cart (quote).
Arguments:
| Type | Name | Description |
|---|---|---|
| string | sessionId |
Session ID |
| int | quoteId | Shopping cart ID |
| string | method | Shipping method code |
| string | storeId | Store view ID or code (optional) |
Return:
| Type | Name | Description |
|---|---|---|
| boolean | result | True if the shipping method is set |
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.method', array(10, 'freeshipping_freeshipping'));
var_dump($result);
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$result = $proxy->shoppingCartShippingMethod($sessionId, 10, 'freeshipping_freeshipping');
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->shoppingCartShippingMethod((object)array('sessionId' => $sessionId->result, 'quoteId' => 10, 'shippingMethod' => 'freeshipping_freeshipping'));
var_dump($result->result);