Module: Mage_Sales
Resource: sales_order_shipment
Aliases:
- order_shipment
Method:
- sales_order_shipment.getCarriers (SOAP V1)
- salesOrderShipmentGetCarriers (SOAP V2)
Allows you to retrieve the list of allowed carriers for an order.
Aliases:
- order_shipment.getCarriers
Arguments:
| Type | Name | Description |
| string | sessionId | Session ID |
| string | orderIncrementId | Order increment ID |
Returns:
| Type | Name | Description |
| associativeArray | result | Array of carriers |
Examples
Request Example SOAP V1
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
// If somestuff requires API authentication,
// then get a session token
$session = $client->login('apiUser', 'apiKey');
$result = $client->call($session, 'sales_order_shipment.getCarriers', '200000010');
var_dump($result);
// If you don't need the session anymore
//$client->endSession($session);
Request Example SOAP V2
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
$result = $proxy->salesOrderShipmentGetCarriers($sessionId, '200000010');
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->salesOrderShipmentGetCarriers((object)array('sessionId' => $sessionId->result, 'orderIncrementId' => '200000010'));
var_dump($result->result);
Response Example SOAP V1
array
'custom' => string 'Custom Value' (length=12)
'dhl' => string 'DHL (Deprecated)' (length=16)
'fedex' => string 'Federal Express' (length=15)
'ups' => string 'United Parcel Service' (length=21)
'usps' => string 'United States Postal Service' (length=28)
'dhlint' => string 'DHL' (length=3)