Class Mage_Usa_Model_Shipping_Carrier_Ups

UPS shipping implementation

Varien_Object

Mage_Usa_Model_Shipping_Carrier_Abstract

Mage_Usa_Model_Shipping_Carrier_Ups implements Mage_Shipping_Model_Carrier_Interface

Package: Mage\Usa
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Usa/Model/Shipping/Carrier/Ups.php

Methods summary
`public Mage_Shipping_Model_Rate_Result\|boolean\|null`	# `collectRates( Mage_Shipping_Model_Rate_Request $request )` Collect and get rates Collect and get rates Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `Mage_Shipping_Model_Rate_Result\|boolean\|null`
`public Mage_Usa_Model_Shipping_Carrier_Ups`	# `setRequest( Mage_Shipping_Model_Rate_Request $request )` Prepare and set request to this instance Prepare and set request to this instance Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `Mage_Usa_Model_Shipping_Carrier_Ups`
`protected float`	# `_getCorrectWeight( float\|integer\|float $weight )` Get correct weigt. Get correct weigt. Namely: Checks the current weight to comply with the minimum weight standards set by the carrier. Then strictly rounds the weight up until the first significant digit after the decimal point. Parameters `$weight` `float\|integer\|float` $weight Returns `float`
`public mixed`	# `getResult( )` Get result of request Get result of request Returns `mixed`
`protected Mage_Shipping_Model_Rate_Result`	# `_getQuotes( )` Do remote request for and handle errors Do remote request for and handle errors Returns `Mage_Shipping_Model_Rate_Result`
`protected null`	# `_setFreeMethodRequest( string $freeMethod )` Set free method request Set free method request Parameters `$freeMethod` `string` $freeMethod Returns `null`
`protected Mage_Shipping_Model_Rate_Result`	# `_getCgiQuotes( )` Get cgi rates Get cgi rates Returns `Mage_Shipping_Model_Rate_Result`
`public array\|boolean`	# `getShipmentByCode( string $code, string $origin = null )` Get shipment by code Get shipment by code Parameters `$code` `string` $code `$origin` `string` $origin Returns `array\|boolean`
`protected Mage_Shipping_Model_Rate_Result`	# `_parseCgiResponse( mixed $response )` Prepare shipping rate result based on response Prepare shipping rate result based on response Parameters `$response` `mixed` $response Returns `Mage_Shipping_Model_Rate_Result`
`public array\|boolean`	# `getCode( string $type, string $code = '' )` Get configuration data of carrier Get configuration data of carrier Parameters `$type` `string` $type `$code` `string` $code Returns `array\|boolean`
`protected Mage_Shipping_Model_Rate_Result`	# `_getXmlQuotes( )` Get xml rates Get xml rates Returns `Mage_Shipping_Model_Rate_Result`
`protected float`	# `_getBaseCurrencyRate( string $code )` Get base currency rate Get base currency rate Parameters `$code` `string` $code Returns `float`
`protected Mage_Shipping_Model_Rate_Result`	# `_parseXmlResponse( mixed $xmlResponse )` Prepare shipping rate result based on response Prepare shipping rate result based on response Parameters `$xmlResponse` `mixed` $response Returns `Mage_Shipping_Model_Rate_Result`
`public mixed`	# `getTracking( mixed $trackings )` Get tracking Get tracking Parameters `$trackings` `mixed` $trackings Returns `mixed`
`protected null`	# `setXMLAccessRequest( )` Set xml access request Set xml access request Returns `null`
`protected mixed`	# `_getCgiTracking( mixed $trackings )` Get cgi tracking Get cgi tracking Parameters `$trackings` `mixed` $trackings Returns `mixed`
`protected mixed`	# `_getXmlTracking( mixed $trackings )` Get xml tracking Get xml tracking Parameters `$trackings` `mixed` $trackings Returns `mixed`
`protected null`	# `_parseXmlTrackingResponse( string $trackingvalue, string $xmlResponse )` Parse xml tracking response Parse xml tracking response Parameters `$trackingvalue` `string` $trackingvalue `$xmlResponse` `string` $response Returns `null`
`public string`	# `getResponse( )` Get tracking response Get tracking response Returns `string`
`public array`	# `getAllowedMethods( )` Get allowed shipping methods Get allowed shipping methods Returns `array` Implementation of `Mage_Shipping_Model_Carrier_Interface::getAllowedMethods()`
`protected string`	# `_formShipmentRequest( Varien_Object $request )` Form XML for shipment request Form XML for shipment request Parameters `$request` `Varien_Object` $request Returns `string`
`protected Varien_Object`	# `_sendShipmentAcceptRequest( SimpleXMLElement $shipmentConfirmResponse )` Send and process shipment accept request Send and process shipment accept request Parameters `$shipmentConfirmResponse` `SimpleXMLElement` Returns `Varien_Object`
`protected Varien_Object`	# `_doShipmentRequest( Varien_Object $request )` Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response Parameters `$request` `Varien_Object` $request Returns `Varien_Object`
`public array\|boolean`	# `getContainerTypes( Varien_Object $params = null )` Return container types of carrier Return container types of carrier Parameters `$params` `Varien_Object\|null` $params Returns `array\|boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::getContainerTypes()`
`public array\|boolean`	# `getContainerTypesAll( )` Return all container types of carrier Return all container types of carrier Returns `array\|boolean`
`public array\|boolean`	# `getContainerTypesFilter( )` Return structured data of containers witch related with shipping methods Return structured data of containers witch related with shipping methods Returns `array\|boolean`
`public array\|boolean`	# `getDeliveryConfirmationTypes( Varien_Object $params = null )` Return delivery confirmation types of carrier Return delivery confirmation types of carrier Parameters `$params` `Varien_Object\|null` $params Returns `array\|boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::getDeliveryConfirmationTypes()`
`public array`	# `getCustomizableContainerTypes( )` Get Container Types, that could be customized for UPS carrier Get Container Types, that could be customized for UPS carrier Returns `array` Overrides `Mage_Shipping_Model_Carrier_Abstract::getCustomizableContainerTypes()`
`protected integer\|null`	# `_getDeliveryConfirmationLevel( mixed $countyDest = null )` Get delivery confirmation level based on origin/destination Return null if delivery confirmation is not acceptable Get delivery confirmation level based on origin/destination Return null if delivery confirmation is not acceptable Returns `integer\|null` Var string $countyDest

Methods inherited from Mage_Usa_Model_Shipping_Carrier_Abstract
`_getCachedQuotes(), _getQuotesCacheKey(), _isUSCountry(), _prepareServiceName(), _prepareShipmentRequest(), _setCachedQuotes(), getAllItems(), getCarrierCode(), getTrackingInfo(), isCityRequired(), isGirthAllowed(), isShippingLabelsAvailable(), isTrackingAvailable(), isZipCodeRequired(), proccessAdditionalValidation(), requestToShipment(), returnOfShipment(), rollBack(), setActiveFlag()`

Methods inherited from Mage_Shipping_Model_Carrier_Abstract
`_debug(), _getAllowedContainers(), _getPerorderPrice(), _getPerpackagePrice(), _updateFreeMethodQuote(), checkAvailableShipCountries(), convertWeightToLbs(), debugData(), getConfigData(), getConfigFlag(), getContentTypes(), getDebugFlag(), getFinalPriceWithHandlingFee(), getMethodPrice(), getSortOrder(), getTotalNumOfBoxes(), isActive(), isFixed(), isStateProvinceRequired()`

Constants summary
`string`	`CODE`	`'ups'`	# Code of the carrier Code of the carrier
`integer`	`DELIVERY_CONFIRMATION_SHIPMENT`	`1`	# Delivery Confirmation level based on origin/destination Delivery Confirmation level based on origin/destination
`integer`	`DELIVERY_CONFIRMATION_PACKAGE`	`2`	#

Constants inherited from Mage_Usa_Model_Shipping_Carrier_Abstract
`GUAM_COUNTRY_ID, GUAM_REGION_CODE, PUERTORICO_COUNTRY_ID`

Constants inherited from Mage_Shipping_Model_Carrier_Abstract
`CANADA_COUNTRY_ID, HANDLING_ACTION_PERORDER, HANDLING_ACTION_PERPACKAGE, HANDLING_TYPE_FIXED, HANDLING_TYPE_PERCENT, MEXICO_COUNTRY_ID, USA_COUNTRY_ID`

Properties summary
`protected string`	`$_code`	`Mage_Usa_Model_Shipping_Carrier_Ups::CODE`	# Code of the carrier Code of the carrier
`protected Mage_Shipping_Model_Rate_Request\|null`	`$_request`	`null`	# Rate request data Rate request data
`protected Varien_Object\|null`	`$_rawRequest`	`null`	# Raw rate request data Raw rate request data
`protected Mage_Shipping_Model_Rate_Result\|null`	`$_result`	`null`	# Rate result data Rate result data
`protected float`	`$_baseCurrencyRate`		# Base currency rate Base currency rate
`protected string`	`$_xmlAccessRequest`	`null`	# Xml access request Xml access request
`protected string`	`$_defaultCgiGatewayUrl`	`'http://www.ups.com:80/using/services/rave/qcostcgi.cgi'`	# Default cgi gateway url Default cgi gateway url
`protected array`	`$_defaultUrls`	`array( 'ShipConfirm' => 'https://wwwcie.ups.com/ups.app/xml/ShipConfirm', 'ShipAccept' => 'https://wwwcie.ups.com/ups.app/xml/ShipAccept', )`	# Default urls for shipment Default urls for shipment
`protected array`	`$_customizableContainerTypes`	`array('CP', 'CSP')`	# Container types that could be customized for UPS carrier Container types that could be customized for UPS carrier

Properties inherited from Mage_Usa_Model_Shipping_Carrier_Abstract
`$_activeFlag, $_quotesCache`

Properties inherited from Mage_Shipping_Model_Carrier_Abstract
`$_debugReplacePrivateDataKeys, $_freeMethod, $_isFixed, $_numBoxes, $_rates`

Packages

Classes

Class Mage_Usa_Model_Shipping_Carrier_Ups

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Returns

Returns

Parameters

Returns

Overrides

Returns

Overrides

Returns

Var