Class Mage_Usa_Model_Shipping_Carrier_Usps

USPS shipping rates estimation

Varien_Object

Mage_Usa_Model_Shipping_Carrier_Abstract

Mage_Usa_Model_Shipping_Carrier_Usps 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>
Link: http://www.usps.com/webtools/htm/Development-Guide-v3-0b.htm
Located at code/core/Mage/Usa/Model/Shipping/Carrier/Usps.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_Usps`	# `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_Usps`
`public mixed`	# `getResult( )` Get result of request Get result of request Returns `mixed`
`protected Mage_Shipping_Model_Rate_Result`	# `_getQuotes( )` Get quotes Get quotes Returns `Mage_Shipping_Model_Rate_Result`
`protected`	# `_setFreeMethodRequest( mixed $freeMethod )` Set free method request Set free method request Parameters `$freeMethod` `mixed` $freeMethod
`protected Mage_Shipping_Model_Rate_Result`	# `_getXmlQuotes( )` Build RateV3 request, send it to USPS gateway and retrieve quotes in XML format Build RateV3 request, send it to USPS gateway and retrieve quotes in XML format Returns `Mage_Shipping_Model_Rate_Result` Link http://www.usps.com/webtools/htm/Rate-Calculators-v2-3.htm
`protected Mage_Shipping_Model_Rate_Result`	# `_parseXmlResponse( string $response )` Parse calculated rates Parse calculated rates Parameters `$response` `string` $response Returns `Mage_Shipping_Model_Rate_Result` Link http://www.usps.com/webtools/htm/Rate-Calculators-v2-3.htm
`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`
`public mixed`	# `getTracking( mixed $trackings )` Get tracking Get tracking Parameters `$trackings` `mixed` $trackings Returns `mixed`
`protected null`	# `setTrackingReqeust( )` Set tracking request Set tracking request Returns `null`
`protected null`	# `_getXmlTracking( array $trackings )` Send request for tracking Send request for tracking Parameters `$trackings` `array` $tracking Returns `null`
`protected null`	# `_parseXmlTrackingResponse( array $trackingvalue, string $response )` Parse xml tracking response Parse xml tracking response Parameters `$trackingvalue` `array` $trackingvalue `$response` `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\|false`	# `_getCountryName( string $countryId )` Return USPS county name by country ISO 3166-1-alpha-2 code Return false for unknown countries Return USPS county name by country ISO 3166-1-alpha-2 code Return false for unknown countries Parameters `$countryId` `string` $countryId Returns `string\|false`
`protected string`	# `_filterServiceName( string $name )` Clean service name from unsupported strings and characters Clean service name from unsupported strings and characters Parameters `$name` `string` $name Returns `string`
`protected string`	# `_formUsExpressShipmentRequest( Varien_Object $request )` Form XML for US shipment request As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be after <FromFirstName /> Form XML for US shipment request As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be after <FromFirstName /> Parameters `$request` `Varien_Object` $request Returns `string`
`protected string`	# `_formUsSignatureConfirmationShipmentRequest( Varien_Object $request, string $serviceType )` Form XML for US Signature Confirmation request As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be after <FromFirstName /> Form XML for US Signature Confirmation request As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be after <FromFirstName /> Parameters `$request` `Varien_Object` $request `$serviceType` `string` $serviceType Returns `string`
`protected array`	# `_convertPoundOunces( float $weightInPounds )` Convert decimal weight into pound-ounces format Convert decimal weight into pound-ounces format Parameters `$weightInPounds` `float` $weightInPounds Returns `array`
`protected string`	# `_formIntlShipmentRequest( Varien_Object $request )` Form XML for international shipment request As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be after <FromFirstName /> Form XML for international shipment request As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be after <FromFirstName /> Parameters `$request` `Varien_Object` $request Returns `string`
`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`	# `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` Overrides `Mage_Shipping_Model_Carrier_Abstract::getDeliveryConfirmationTypes()`
`public boolean`	# `isGirthAllowed( null\|string $countyDest = null )` Check whether girth is allowed for the USPS Check whether girth is allowed for the USPS Parameters `$countyDest` `null\|string` $countyDest Returns `boolean` Overrides `Mage_Usa_Model_Shipping_Carrier_Abstract::isGirthAllowed()`
`public array`	# `getContentTypes( Varien_Object $params )` Return content types of package Return content types of package Parameters `$params` `Varien_Object` $params Returns `array` Overrides `Mage_Shipping_Model_Carrier_Abstract::getContentTypes()`
`protected array`	# `_parseZip( string $zipString, boolean $returnFull = false )` Parse zip from string to zip5-zip4 Parse zip from string to zip5-zip4 Parameters `$zipString` `string` $zipString `$returnFull` `boolean` $returnFull Returns `array`

Methods inherited from Mage_Usa_Model_Shipping_Carrier_Abstract
`_getCachedQuotes(), _getQuotesCacheKey(), _isUSCountry(), _prepareServiceName(), _prepareShipmentRequest(), _setCachedQuotes(), getAllItems(), getCarrierCode(), getTrackingInfo(), isCityRequired(), 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(), getCustomizableContainerTypes(), getDebugFlag(), getFinalPriceWithHandlingFee(), getMethodPrice(), getSortOrder(), getTotalNumOfBoxes(), isActive(), isFixed(), isStateProvinceRequired()`

Constants summary
`string`	`CONTAINER_VARIABLE`	`'VARIABLE'`	# USPS containers USPS containers
`string`	`CONTAINER_FLAT_RATE_BOX`	`'FLAT RATE BOX'`	#
`string`	`CONTAINER_FLAT_RATE_ENVELOPE`	`'FLAT RATE ENVELOPE'`	#
`string`	`CONTAINER_RECTANGULAR`	`'RECTANGULAR'`	#
`string`	`CONTAINER_NONRECTANGULAR`	`'NONRECTANGULAR'`	#
`string`	`SIZE_REGULAR`	`'REGULAR'`	# USPS size USPS size
`string`	`SIZE_LARGE`	`'LARGE'`	#
`integer`	`DEFAULT_REVISION`	`2`	# Default api revision Default api revision
`string`	`CODE`	`'usps'`	# Code of the carrier Code of the carrier
`integer`	`OUNCES_POUND`	`16`	# Ounces in one pound for conversion Ounces in one pound for conversion

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_Usps::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 string`	`$_defaultGatewayUrl`	`'http://production.shippingapis.com/ShippingAPI.dll'`	# Default cgi gateway url Default cgi gateway url
`protected array`	`$_customizableContainerTypes`	`array('VARIABLE', 'RECTANGULAR', 'NONRECTANGULAR')`	# Container types that could be customized for USPS carrier Container types that could be customized for USPS 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_Usps

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Link

Parameters

Returns

Link

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Returns

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns