Carrier Class Reference

Inheritance diagram for Carrier:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, \Psr\Log\LoggerInterface $logger, Security $xmlSecurity, \Magento\Shipping\Model\Simplexml\ElementFactory $xmlElFactory, \Magento\Shipping\Model\Rate\ResultFactory $rateFactory, \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory, \Magento\Shipping\Model\Tracking\ResultFactory $trackFactory, \Magento\Shipping\Model\Tracking\Result\ErrorFactory $trackErrorFactory, \Magento\Shipping\Model\Tracking\Result\StatusFactory $trackStatusFactory, \Magento\Directory\Model\RegionFactory $regionFactory, \Magento\Directory\Model\CountryFactory $countryFactory, \Magento\Directory\Model\CurrencyFactory $currencyFactory, \Magento\Directory\Helper\Data $directoryData, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, \Magento\Framework\Locale\FormatInterface $localeFormat, Config $configHelper, ClientFactory $httpClientFactory, array $data=[])
	collectRates (RateRequest $request)
	setRequest (RateRequest $request)
	getResult ()
	getShipmentByCode ($code, $origin=null)
	getTracking ($trackings)
	getResponse ()
	getAllowedMethods ()
	getShipAcceptUrl ()
	getShipConfirmUrl ()
	getContainerTypes (\Magento\Framework\DataObject $params=null)
	getContainerTypesAll ()
	getContainerTypesFilter ()
	getDeliveryConfirmationTypes (\Magento\Framework\DataObject $params=null)
	getCustomizableContainerTypes ()
Public Member Functions inherited from AbstractCarrierOnline
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, \Psr\Log\LoggerInterface $logger, Security $xmlSecurity, \Magento\Shipping\Model\Simplexml\ElementFactory $xmlElFactory, \Magento\Shipping\Model\Rate\ResultFactory $rateFactory, \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory, \Magento\Shipping\Model\Tracking\ResultFactory $trackFactory, \Magento\Shipping\Model\Tracking\Result\ErrorFactory $trackErrorFactory, \Magento\Shipping\Model\Tracking\Result\StatusFactory $trackStatusFactory, \Magento\Directory\Model\RegionFactory $regionFactory, \Magento\Directory\Model\CountryFactory $countryFactory, \Magento\Directory\Model\CurrencyFactory $currencyFactory, \Magento\Directory\Helper\Data $directoryData, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, array $data=[])
	setActiveFlag ($code='active')
	getCarrierCode ()
	getTrackingInfo ($tracking)
	isTrackingAvailable ()
	isCityRequired ()
	isZipCodeRequired ($countryId=null)
	isShippingLabelsAvailable ()
	getAllItems (RateRequest $request)
	proccessAdditionalValidation (\Magento\Framework\DataObject $request)
	requestToShipment ($request)
	returnOfShipment ($request)
	rollBack ($data)
	isGirthAllowed ($countyDest=null, $carrierMethodCode=null)
	setRawRequest ($request)
	getMethodPrice ($cost, $method='')
	parseXml ($xmlContent, $customSimplexml='SimpleXMLElement')
	canCollectRates ()
Public Member Functions inherited from AbstractCarrier
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, \Psr\Log\LoggerInterface $logger, array $data=[])
	getConfigData ($field)
	getConfigFlag ($field)
	requestToShipment ($request)
	returnOfShipment ($request)
	getContainerTypes (\Magento\Framework\DataObject $params=null)
	getCustomizableContainerTypes ()
	getDeliveryConfirmationTypes (\Magento\Framework\DataObject $params=null)
	processAdditionalValidation (\Magento\Framework\DataObject $request)
	proccessAdditionalValidation (\Magento\Framework\DataObject $request)
	isActive ()
	isFixed ()
	isTrackingAvailable ()
	isShippingLabelsAvailable ()
	getSortOrder ()
	getFinalPriceWithHandlingFee ($cost)
	getTotalNumOfBoxes ($weight)
	isStateProvinceRequired ()
	isCityRequired ()
	isZipCodeRequired ($countryId=null)
	getDebugFlag ()
	debugData ($debugData)
	getCarrierCode ()
	getContentTypes (\Magento\Framework\DataObject $params)
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from AbstractCarrierInterface
	checkAvailableShipCountries (\Magento\Framework\DataObject $request)
Public Member Functions inherited from CarrierInterface
	isTrackingAvailable ()

Data Fields
const	CODE = 'ups'
const	DELIVERY_CONFIRMATION_SHIPMENT = 1
const	DELIVERY_CONFIRMATION_PACKAGE = 2
Data Fields inherited from AbstractCarrierOnline
const	USA_COUNTRY_ID = 'US'
const	PUERTORICO_COUNTRY_ID = 'PR'
const	GUAM_COUNTRY_ID = 'GU'
const	GUAM_REGION_CODE = 'GU'
Data Fields inherited from AbstractCarrier
const	DEBUG_KEYS_MASK = '****'
const	USA_COUNTRY_ID = 'US'
const	CANADA_COUNTRY_ID = 'CA'
const	MEXICO_COUNTRY_ID = 'MX'
const	HANDLING_TYPE_PERCENT = 'P'
const	HANDLING_TYPE_FIXED = 'F'
const	HANDLING_ACTION_PERPACKAGE = 'P'
const	HANDLING_ACTION_PERORDER = 'O'

Protected Member Functions
	_getCorrectWeight ($weight)
	_getQuotes ()
	_setFreeMethodRequest ($freeMethod)
	_getCgiQuotes ()
	_parseCgiResponse ($response)
	_getXmlQuotes ()
	_getBaseCurrencyRate ($code)
	_parseXmlResponse ($xmlResponse)
	setXMLAccessRequest ()
	_getCgiTracking ($trackings)
	_getXmlTracking ($trackings)
	_parseXmlTrackingResponse ($trackingValue, $xmlResponse)
	_sendShipmentAcceptRequest (Element $shipmentConfirmResponse)
	_doShipmentRequest (\Magento\Framework\DataObject $request)
	_getDeliveryConfirmationLevel ($countyDestination=null)
Protected Member Functions inherited from AbstractCarrierOnline
	_getQuotesCacheKey ($requestParams)
	_getCachedQuotes ($requestParams)
	_setCachedQuotes ($requestParams, $response)
	_prepareServiceName ($name)
	_prepareShipmentRequest (\Magento\Framework\DataObject $request)
	_doShipmentRequest (\Magento\Framework\DataObject $request)
	_isUSCountry ($countyId)
	debugErrors ($errors)
	getErrorMessage ()
Protected Member Functions inherited from AbstractCarrier
	_getAllowedContainers (\Magento\Framework\DataObject $params=null)
	_updateFreeMethodQuote ($request)
	_getPerpackagePrice ($cost, $handlingType, $handlingFee)
	_getPerorderPrice ($cost, $handlingType, $handlingFee)
	_debug ($debugData)
	filterDebugData ($data)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_code = self::CODE
	$_request
	$_result
	$_baseCurrencyRate
	$_xmlAccessRequest
	$_defaultCgiGatewayUrl = 'http://www.ups.com:80/using/services/rave/qcostcgi.cgi'
	$_defaultUrls
	$_liveUrls
	$_customizableContainerTypes = ['CP', 'CSP']
	$_localeFormat
	$_logger
	$configHelper
	$_debugReplacePrivateDataKeys
Protected Attributes inherited from AbstractCarrierOnline
	$_activeFlag = 'active'
	$_directoryData = null
	$_xmlElFactory
	$_rateFactory
	$_rateMethodFactory
	$_trackFactory
	$_trackErrorFactory
	$_trackStatusFactory
	$_regionFactory
	$_countryFactory
	$_currencyFactory
	$stockRegistry
	$_rawRequest = null
	$xmlSecurity
Protected Attributes inherited from AbstractCarrier
	$_code
	$_rates
	$_numBoxes = 1
	$_freeMethod = 'free_method'
	$_isFixed = false
	$_customizableContainerTypes = []
	$_debugReplacePrivateDataKeys = []
	$_scopeConfig
	$_rateErrorFactory
	$_logger
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from AbstractCarrierOnline
static	$_quotesCache = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

UPS shipping implementation @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 24 of file Carrier.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory	$rateErrorFactory,
		\Psr\Log\LoggerInterface	$logger,
		Security	$xmlSecurity,
		\Magento\Shipping\Model\Simplexml\ElementFactory	$xmlElFactory,
		\Magento\Shipping\Model\Rate\ResultFactory	$rateFactory,
		\Magento\Quote\Model\Quote\Address\RateResult\MethodFactory	$rateMethodFactory,
		\Magento\Shipping\Model\Tracking\ResultFactory	$trackFactory,
		\Magento\Shipping\Model\Tracking\Result\ErrorFactory	$trackErrorFactory,
		\Magento\Shipping\Model\Tracking\Result\StatusFactory	$trackStatusFactory,
		\Magento\Directory\Model\RegionFactory	$regionFactory,
		\Magento\Directory\Model\CountryFactory	$countryFactory,
		\Magento\Directory\Model\CurrencyFactory	$currencyFactory,
		\Magento\Directory\Helper\Data	$directoryData,
		\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry,
		\Magento\Framework\Locale\FormatInterface	$localeFormat,
		Config	$configHelper,
		ClientFactory	$httpClientFactory,
		array	$data = []
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory	$rateErrorFactory
\Psr\Log\LoggerInterface	$logger
Security	$xmlSecurity
\Magento\Shipping\Model\Simplexml\ElementFactory	$xmlElFactory
\Magento\Shipping\Model\Rate\ResultFactory	$rateFactory
\Magento\Quote\Model\Quote\Address\RateResult\MethodFactory	$rateMethodFactory
\Magento\Shipping\Model\Tracking\ResultFactory	$trackFactory
\Magento\Shipping\Model\Tracking\Result\ErrorFactory	$trackErrorFactory
\Magento\Shipping\Model\Tracking\Result\StatusFactory	$trackStatusFactory
\Magento\Directory\Model\RegionFactory	$regionFactory
\Magento\Directory\Model\CountryFactory	$countryFactory
\Magento\Directory\Model\CurrencyFactory	$currencyFactory
\Magento\Directory\Helper\Data	$directoryData
\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry
\Magento\Framework\Locale\FormatInterface	$localeFormat
Config	$configHelper
ClientFactory	$httpClientFactory
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 159 of file Carrier.php.

      {
        parent::__construct(
            $scopeConfig,
            $rateErrorFactory,
            $logger,
            $xmlSecurity,
            $xmlElFactory,
            $rateFactory,
            $rateMethodFactory,
            $trackFactory,
            $trackErrorFactory,
            $trackStatusFactory,
            $regionFactory,
            $countryFactory,
            $currencyFactory,
            $directoryData,
            $stockRegistry,
            $data
        );
        $this->httpClientFactory = $httpClientFactory;
        $this->_localeFormat = $localeFormat;
        $this->configHelper = $configHelper;
    }

Member Function Documentation

_doShipmentRequest()

_doShipmentRequest ( \Magento\Framework\DataObject  $request )

protected

Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response

Parameters

\Magento\Framework\DataObject

$request

Returns

\Magento\Framework\DataObject

Definition at line 1504 of file Carrier.php.

    {
        $this->_prepareShipmentRequest($request);
        $result = new \Magento\Framework\DataObject();
        $rawXmlRequest = $this->_formShipmentRequest($request);
        $this->setXMLAccessRequest();
        $xmlRequest = $this->_xmlAccessRequest . $rawXmlRequest;
        $xmlResponse = $this->_getCachedQuotes($xmlRequest);

        if ($xmlResponse === null) {
            $debugData['request'] = $this->filterDebugData($this->_xmlAccessRequest) . $rawXmlRequest;
            $url = $this->getShipConfirmUrl();
            $client = $this->httpClientFactory->create();
            try {
                $client->post($url, $xmlRequest);
                $xmlResponse = $client->getBody();
                $debugData['result'] = $xmlResponse;
                $this->_setCachedQuotes($xmlRequest, $xmlResponse);
            } catch (\Throwable $e) {
                $debugData['result'] = ['code' => $e->getCode(), 'error' => $e->getMessage()];
            }
        }

        try {
            $response = $this->_xmlElFactory->create(['data' => $xmlResponse]);
        } catch (\Throwable $e) {
            $debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
            $result->setErrors($e->getMessage());
        }

        if (isset($response->Response->Error)
            && in_array($response->Response->Error->ErrorSeverity, ['Hard', 'Transient'])
        ) {
            $result->setErrors((string)$response->Response->Error->ErrorDescription);
        }

        $this->_debug($debugData);

        if ($result->hasErrors() || empty($response)) {
            return $result;
        } else {
            return $this->_sendShipmentAcceptRequest($response);
        }
    }

_getBaseCurrencyRate()

_getBaseCurrencyRate (   $code )

protected

Get base currency rate

Parameters

string

$code

Returns

float

Definition at line 768 of file Carrier.php.

    {
        if (!$this->_baseCurrencyRate) {
            $this->_baseCurrencyRate = $this->_currencyFactory->create()->load(
                $code
            )->getAnyRate(
                $this->_request->getBaseCurrency()->getCode()
            );
        }

        return $this->_baseCurrencyRate;
    }

_getCgiQuotes()

_getCgiQuotes ( )

protected

Get cgi rates

Returns

Result

Definition at line 445 of file Carrier.php.

    {
        $rowRequest = $this->_rawRequest;
        if (self::USA_COUNTRY_ID == $rowRequest->getDestCountry()) {
            $destPostal = substr($rowRequest->getDestPostal(), 0, 5);
        } else {
            $destPostal = $rowRequest->getDestPostal();
        }

        $params = [
            'accept_UPS_license_agreement' => 'yes',
            '10_action' => $rowRequest->getAction(),
            '13_product' => $rowRequest->getProduct(),
            '14_origCountry' => $rowRequest->getOrigCountry(),
            '15_origPostal' => $rowRequest->getOrigPostal(),
            'origCity' => $rowRequest->getOrigCity(),
            '19_destPostal' => $destPostal,
            '22_destCountry' => $rowRequest->getDestCountry(),
            '23_weight' => $rowRequest->getWeight(),
            '47_rate_chart' => $rowRequest->getPickup(),
            '48_container' => $rowRequest->getContainer(),
            '49_residential' => $rowRequest->getDestType(),
            'weight_std' => strtolower($rowRequest->getUnitMeasure()),
        ];
        $params['47_rate_chart'] = $params['47_rate_chart']['label'];

        $responseBody = $this->_getCachedQuotes($params);
        if ($responseBody === null) {
            $debugData = ['request' => $params];
            try {
                $url = $this->getConfigData('gateway_url');
                if (!$url) {
                    $url = $this->_defaultCgiGatewayUrl;
                }
                $client = new \Zend_Http_Client();
                $client->setUri($url);
                $client->setConfig(['maxredirects' => 0, 'timeout' => 30]);
                $client->setParameterGet($params);
                $response = $client->request();
                $responseBody = $response->getBody();

                $debugData['result'] = $responseBody;
                $this->_setCachedQuotes($params, $responseBody);
            } catch (\Throwable $e) {
                $debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
                $responseBody = '';
            }
            $this->_debug($debugData);
        }

        return $this->_parseCgiResponse($responseBody);
    }

_getCgiTracking()

_getCgiTracking (   $trackings )

protected

Get cgi tracking

Parameters

string[]

$trackings

Returns

\Magento\Shipping\Model\Tracking\ResultFactory

Definition at line 988 of file Carrier.php.

    {
        //ups no longer support tracking for data streaming version
        //so we can only reply the popup window to ups.
        $result = $this->_trackFactory->create();
        foreach ($trackings as $tracking) {
            $status = $this->_trackStatusFactory->create();
            $status->setCarrier('ups');
            $status->setCarrierTitle($this->getConfigData('title'));
            $status->setTracking($tracking);
            $status->setPopup(1);
            $status->setUrl(
                "http://wwwapps.ups.com/WebTracking/processInputRequest?HTMLVersion=5.0&error_carried=true" .
                "&tracknums_displayed=5&TypeOfInquiryNumber=T&loc=en_US&InquiryNumber1={$tracking}" .
                "&AgreeToTermsAndConditions=yes"
            );
            $result->append($status);
        }

        $this->_result = $result;

        return $result;
    }

_getCorrectWeight()

_getCorrectWeight (   $weight )

protected

Get correct weight

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

float | int

$weight

Returns

float

Definition at line 380 of file Carrier.php.

    {
        $minWeight = $this->getConfigData('min_package_weight');

        if ($weight < $minWeight) {
            $weight = $minWeight;
        }

        //rounds a number to one significant figure
        $weight = ceil($weight * 10) / 10;

        return $weight;
    }

_getDeliveryConfirmationLevel()

_getDeliveryConfirmationLevel (   $countyDestination = null )

protected

Get delivery confirmation level based on origin/destination Return null if delivery confirmation is not acceptable

Parameters

string | null

$countyDestination

Returns

int|null

Definition at line 1708 of file Carrier.php.

    {
        if ($countyDestination === null) {
            return null;
        }

        if ($countyDestination == self::USA_COUNTRY_ID) {
            return self::DELIVERY_CONFIRMATION_PACKAGE;
        }

        return self::DELIVERY_CONFIRMATION_SHIPMENT;
    }

_getQuotes()

_getQuotes ( )

protected

Do remote request for and handle errors

Returns

Result|null

Definition at line 409 of file Carrier.php.

    {
        switch ($this->getConfigData('type')) {
            case 'UPS':
                return $this->_getCgiQuotes();
            case 'UPS_XML':
                return $this->_getXmlQuotes();
            default:
                break;
        }

        return null;
    }

_getXmlQuotes()

_getXmlQuotes ( )

protected

Get xml rates

Returns

Result @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity) @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 597 of file Carrier.php.

    {
        $url = $this->getConfigData('gateway_xml_url');

        $this->setXMLAccessRequest();
        $xmlRequest = $this->_xmlAccessRequest;
        $debugData['accessRequest'] = $this->filterDebugData($xmlRequest);

        $rowRequest = $this->_rawRequest;
        if (self::USA_COUNTRY_ID == $rowRequest->getDestCountry()) {
            $destPostal = substr($rowRequest->getDestPostal(), 0, 5);
        } else {
            $destPostal = $rowRequest->getDestPostal();
        }
        $params = [
            'accept_UPS_license_agreement' => 'yes',
            '10_action' => $rowRequest->getAction(),
            '13_product' => $rowRequest->getProduct(),
            '14_origCountry' => $rowRequest->getOrigCountry(),
            '15_origPostal' => $rowRequest->getOrigPostal(),
            'origCity' => $rowRequest->getOrigCity(),
            'origRegionCode' => $rowRequest->getOrigRegionCode(),
            '19_destPostal' => $destPostal,
            '22_destCountry' => $rowRequest->getDestCountry(),
            'destRegionCode' => $rowRequest->getDestRegionCode(),
            '23_weight' => $rowRequest->getWeight(),
            '47_rate_chart' => $rowRequest->getPickup(),
            '48_container' => $rowRequest->getContainer(),
            '49_residential' => $rowRequest->getDestType(),
        ];

        if ($params['10_action'] == '4') {
            $params['10_action'] = 'Shop';
            $serviceCode = null;
        } else {
            $params['10_action'] = 'Rate';
            $serviceCode = $rowRequest->getProduct() ? $rowRequest->getProduct() : null;
        }
        $serviceDescription = $serviceCode ? $this->getShipmentByCode($serviceCode) : '';

        $xmlParams = <<<XMLRequest
<?xml version="1.0"?>
<RatingServiceSelectionRequest xml:lang="en-US">
  <Request>
    <TransactionReference>
      <CustomerContext>Rating and Service</CustomerContext>
      <XpciVersion>1.0</XpciVersion>
    </TransactionReference>
    <RequestAction>Rate</RequestAction>
    <RequestOption>{$params['10_action']}</RequestOption>
  </Request>
  <PickupType>
          <Code>{$params['47_rate_chart']['code']}</Code>
          <Description>{$params['47_rate_chart']['label']}</Description>
  </PickupType>

  <Shipment>
XMLRequest;

        if ($serviceCode !== null) {
            $xmlParams .= "<Service>" .
                "<Code>{$serviceCode}</Code>" .
                "<Description>{$serviceDescription}</Description>" .
                "</Service>";
        }

        $xmlParams .= <<<XMLRequest
      <Shipper>
XMLRequest;

        if ($this->getConfigFlag('negotiated_active') && ($shipperNumber = $this->getConfigData('shipper_number'))) {
            $xmlParams .= "<ShipperNumber>{$shipperNumber}</ShipperNumber>";
        }

        if ($rowRequest->getIsReturn()) {
            $shipperCity = '';
            $shipperPostalCode = $params['19_destPostal'];
            $shipperCountryCode = $params['22_destCountry'];
            $shipperStateProvince = $params['destRegionCode'];
        } else {
            $shipperCity = $params['origCity'];
            $shipperPostalCode = $params['15_origPostal'];
            $shipperCountryCode = $params['14_origCountry'];
            $shipperStateProvince = $params['origRegionCode'];
        }

        $xmlParams .= <<<XMLRequest
      <Address>
          <City>{$shipperCity}</City>
          <PostalCode>{$shipperPostalCode}</PostalCode>
          <CountryCode>{$shipperCountryCode}</CountryCode>
          <StateProvinceCode>{$shipperStateProvince}</StateProvinceCode>
      </Address>
    </Shipper>
    
    <ShipTo>
      <Address>
          <PostalCode>{$params['19_destPostal']}</PostalCode>
          <CountryCode>{$params['22_destCountry']}</CountryCode>
          <ResidentialAddress>{$params['49_residential']}</ResidentialAddress>
          <StateProvinceCode>{$params['destRegionCode']}</StateProvinceCode>
XMLRequest;

        if ($params['49_residential'] === '01') {
            $xmlParams .= "<ResidentialAddressIndicator>{$params['49_residential']}</ResidentialAddressIndicator>";
        }

        $xmlParams .= <<<XMLRequest
      </Address>
    </ShipTo>
    
    <ShipFrom>
      <Address>
          <PostalCode>{$params['15_origPostal']}</PostalCode>
          <CountryCode>{$params['14_origCountry']}</CountryCode>
          <StateProvinceCode>{$params['origRegionCode']}</StateProvinceCode>
      </Address>
    </ShipFrom>

    <Package>
      <PackagingType>
        <Code>{$params['48_container']}</Code>
      </PackagingType>
      <PackageWeight>
        <UnitOfMeasurement>
          <Code>{$rowRequest->getUnitMeasure()}</Code>
        </UnitOfMeasurement>
        <Weight>{$params['23_weight']}</Weight>
      </PackageWeight>
    </Package>
XMLRequest;

        if ($this->getConfigFlag('negotiated_active')) {
            $xmlParams .= "<RateInformation><NegotiatedRatesIndicator/></RateInformation>";
        }
        if ($this->getConfigFlag('include_taxes')) {
            $xmlParams .= "<TaxInformationIndicator/>";
        }

        $xmlParams .= <<<XMLRequest
      </Shipment>
    </RatingServiceSelectionRequest>
XMLRequest;

        $xmlRequest .= $xmlParams;

        $xmlResponse = $this->_getCachedQuotes($xmlRequest);
        if ($xmlResponse === null) {
            $debugData['request'] = $xmlParams;
            try {
                $client = $this->httpClientFactory->create();
                $client->post($url, $xmlRequest);
                $xmlResponse = $client->getBody();
                $debugData['result'] = $xmlResponse;
                $this->_setCachedQuotes($xmlRequest, $xmlResponse);
            } catch (\Throwable $e) {
                $debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
                $xmlResponse = '';
            }
            $this->_debug($debugData);
        }

        return $this->_parseXmlResponse($xmlResponse);
    }

_getXmlTracking()

_getXmlTracking (   $trackings )

protected

Get xml tracking

Parameters

string[]

$trackings

Returns

Result

RequestOption==>'1' to request all activities

Definition at line 1018 of file Carrier.php.

    {
        $url = $this->getConfigData('tracking_xml_url');

        foreach ($trackings as $tracking) {
            $xmlRequest = <<<XMLAuth
<?xml version="1.0" ?>
<TrackRequest xml:lang="en-US">
    <Request>
        <RequestAction>Track</RequestAction>
        <RequestOption>1</RequestOption>
    </Request>
    <TrackingNumber>$tracking</TrackingNumber>
    <IncludeFreight>01</IncludeFreight>
</TrackRequest>
XMLAuth;
            $debugData['request'] = $this->filterDebugData($this->_xmlAccessRequest) . $xmlRequest;
            try {
                $client = $this->httpClientFactory->create();
                $client->post($url, $this->_xmlAccessRequest . $xmlRequest);
                $xmlResponse = $client->getBody();
                $debugData['result'] = $xmlResponse;
            } catch (\Throwable $e) {
                $debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
                $xmlResponse = '';
            }

            $this->_debug($debugData);
            $this->_parseXmlTrackingResponse($tracking, $xmlResponse);
        }

        return $this->_result;
    }

_parseCgiResponse()

_parseCgiResponse (   $response )

protected

Prepare shipping rate result based on response

Parameters

string

$response

Returns

Result @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 525 of file Carrier.php.

    {
        $costArr = [];
        $priceArr = [];
        if (strlen(trim($response)) > 0) {
            $rRows = explode("\n", $response);
            $allowedMethods = explode(",", $this->getConfigData('allowed_methods'));
            foreach ($rRows as $rRow) {
                $row = explode('%', $rRow);
                switch (substr($row[0], -1)) {
                    case 3:
                    case 4:
                        if (in_array($row[1], $allowedMethods)) {
                            $responsePrice = $this->_localeFormat->getNumber($row[8]);
                            $costArr[$row[1]] = $responsePrice;
                            $priceArr[$row[1]] = $this->getMethodPrice($responsePrice, $row[1]);
                        }
                        break;
                    case 5:
                        $errorTitle = $row[1];
                        $message = __(
                            'Sorry, something went wrong. Please try again or contact us and we\'ll try to help.'
                        );
                        $this->_logger->debug($message . ': ' . $errorTitle);
                        break;
                    case 6:
                        if (in_array($row[3], $allowedMethods)) {
                            $responsePrice = $this->_localeFormat->getNumber($row[10]);
                            $costArr[$row[3]] = $responsePrice;
                            $priceArr[$row[3]] = $this->getMethodPrice($responsePrice, $row[3]);
                        }
                        break;
                    default:
                        break;
                }
            }
            asort($priceArr);
        }

        $result = $this->_rateFactory->create();

        if (empty($priceArr)) {
            $error = $this->_rateErrorFactory->create();
            $error->setCarrier('ups');
            $error->setCarrierTitle($this->getConfigData('title'));
            $error->setErrorMessage($this->getConfigData('specificerrmsg'));
            $result->append($error);
        } else {
            foreach ($priceArr as $method => $price) {
                $rate = $this->_rateMethodFactory->create();
                $rate->setCarrier('ups');
                $rate->setCarrierTitle($this->getConfigData('title'));
                $rate->setMethod($method);
                $methodArray = $this->configHelper->getCode('method', $method);
                $rate->setMethodTitle($methodArray);
                $rate->setCost($costArr[$method]);
                $rate->setPrice($price);
                $result->append($rate);
            }
        }

        return $result;
    }

_parseXmlResponse()

_parseXmlResponse (   $xmlResponse )

protected

Prepare shipping rate result based on response

Parameters

mixed

$xmlResponse

Returns

Result @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.ExcessiveMethodLength) @SuppressWarnings(PHPMD.ElseExpression)

Definition at line 806 of file Carrier.php.

    {
        $costArr = [];
        $priceArr = [];
        if (strlen(trim($xmlResponse)) > 0) {
            $xml = new \Magento\Framework\Simplexml\Config();
            $xml->loadString($xmlResponse);
            $arr = $xml->getXpath("//RatingServiceSelectionResponse/Response/ResponseStatusCode/text()");
            $success = (int)$arr[0];
            if ($success === 1) {
                $arr = $xml->getXpath("//RatingServiceSelectionResponse/RatedShipment");
                $allowedMethods = explode(",", $this->getConfigData('allowed_methods'));

                // Negotiated rates
                $negotiatedArr = $xml->getXpath("//RatingServiceSelectionResponse/RatedShipment/NegotiatedRates");
                $negotiatedActive = $this->getConfigFlag('negotiated_active')
                    && $this->getConfigData('shipper_number')
                    && !empty($negotiatedArr);

                $allowedCurrencies = $this->_currencyFactory->create()->getConfigAllowCurrencies();
                foreach ($arr as $shipElement) {
                    $code = (string)$shipElement->Service->Code;
                    if (in_array($code, $allowedMethods)) {
                        //The location of tax information is in a different place
                        // depending on whether we are using negotiated rates or not
                        if ($negotiatedActive) {
                            $includeTaxesArr = $xml->getXpath(
                                "//RatingServiceSelectionResponse/RatedShipment/NegotiatedRates"
                                . "/NetSummaryCharges/TotalChargesWithTaxes"
                            );
                            $includeTaxesActive = $this->getConfigFlag('include_taxes') && !empty($includeTaxesArr);
                            if ($includeTaxesActive) {
                                $cost = $shipElement->NegotiatedRates
                                    ->NetSummaryCharges
                                    ->TotalChargesWithTaxes
                                    ->MonetaryValue;

                                $responseCurrencyCode = $this->mapCurrencyCode(
                                    (string)$shipElement->NegotiatedRates
                                        ->NetSummaryCharges
                                        ->TotalChargesWithTaxes
                                        ->CurrencyCode
                                );
                            } else {
                                $cost = $shipElement->NegotiatedRates->NetSummaryCharges->GrandTotal->MonetaryValue;
                                $responseCurrencyCode = $this->mapCurrencyCode(
                                    (string)$shipElement->NegotiatedRates->NetSummaryCharges->GrandTotal->CurrencyCode
                                );
                            }
                        } else {
                            $includeTaxesArr = $xml->getXpath(
                                "//RatingServiceSelectionResponse/RatedShipment/TotalChargesWithTaxes"
                            );
                            $includeTaxesActive = $this->getConfigFlag('include_taxes') && !empty($includeTaxesArr);
                            if ($includeTaxesActive) {
                                $cost = $shipElement->TotalChargesWithTaxes->MonetaryValue;
                                $responseCurrencyCode = $this->mapCurrencyCode(
                                    (string)$shipElement->TotalChargesWithTaxes->CurrencyCode
                                );
                            } else {
                                $cost = $shipElement->TotalCharges->MonetaryValue;
                                $responseCurrencyCode = $this->mapCurrencyCode(
                                    (string)$shipElement->TotalCharges->CurrencyCode
                                );
                            }
                        }

                        //convert price with Origin country currency code to base currency code
                        $successConversion = true;
                        if ($responseCurrencyCode) {
                            if (in_array($responseCurrencyCode, $allowedCurrencies)) {
                                $cost = (double)$cost * $this->_getBaseCurrencyRate($responseCurrencyCode);
                            } else {
                                $errorTitle = __(
                                    'We can\'t convert a rate from "%1-%2".',
                                    $responseCurrencyCode,
                                    $this->_request->getPackageCurrency()->getCode()
                                );
                                $error = $this->_rateErrorFactory->create();
                                $error->setCarrier('ups');
                                $error->setCarrierTitle($this->getConfigData('title'));
                                $error->setErrorMessage($errorTitle);
                                $successConversion = false;
                            }
                        }

                        if ($successConversion) {
                            $costArr[$code] = $cost;
                            $priceArr[$code] = $this->getMethodPrice((float)$cost, $code);
                        }
                    }
                }
            } else {
                $arr = $xml->getXpath("//RatingServiceSelectionResponse/Response/Error/ErrorDescription/text()");
                $errorTitle = (string)$arr[0][0];
                $error = $this->_rateErrorFactory->create();
                $error->setCarrier('ups');
                $error->setCarrierTitle($this->getConfigData('title'));
                $error->setErrorMessage($this->getConfigData('specificerrmsg'));
            }
        }

        $result = $this->_rateFactory->create();

        if (empty($priceArr)) {
            $error = $this->_rateErrorFactory->create();
            $error->setCarrier('ups');
            $error->setCarrierTitle($this->getConfigData('title'));
            if ($this->getConfigData('specificerrmsg') !== '') {
                $errorTitle = $this->getConfigData('specificerrmsg');
            }
            if (!isset($errorTitle)) {
                $errorTitle = __('Cannot retrieve shipping rates');
            }
            $error->setErrorMessage($errorTitle);
            $result->append($error);
        } else {
            foreach ($priceArr as $method => $price) {
                $rate = $this->_rateMethodFactory->create();
                $rate->setCarrier('ups');
                $rate->setCarrierTitle($this->getConfigData('title'));
                $rate->setMethod($method);
                $methodArr = $this->getShipmentByCode($method);
                $rate->setMethodTitle($methodArr);
                $rate->setCost($costArr[$method]);
                $rate->setPrice($price);
                $result->append($rate);
            }
        }

        return $result;
    }

_parseXmlTrackingResponse()

_parseXmlTrackingResponse (   $trackingValue,   $xmlResponse  )

protected

Parse xml tracking response

Parameters

string	$trackingValue
string	$xmlResponse

Returns

null @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 1064 of file Carrier.php.

    {
        $errorTitle = 'For some reason we can\'t retrieve tracking info right now.';
        $resultArr = [];
        $packageProgress = [];

        if ($xmlResponse) {
            $xml = new \Magento\Framework\Simplexml\Config();
            $xml->loadString($xmlResponse);
            $arr = $xml->getXpath("//TrackResponse/Response/ResponseStatusCode/text()");
            $success = (int)$arr[0][0];

            if ($success === 1) {
                $arr = $xml->getXpath("//TrackResponse/Shipment/Service/Description/text()");
                $resultArr['service'] = (string)$arr[0];

                $arr = $xml->getXpath("//TrackResponse/Shipment/PickupDate/text()");
                $resultArr['shippeddate'] = (string)$arr[0];

                $arr = $xml->getXpath("//TrackResponse/Shipment/Package/PackageWeight/Weight/text()");
                $weight = (string)$arr[0];

                $arr = $xml->getXpath("//TrackResponse/Shipment/Package/PackageWeight/UnitOfMeasurement/Code/text()");
                $unit = (string)$arr[0];

                $resultArr['weight'] = "{$weight} {$unit}";

                $activityTags = $xml->getXpath("//TrackResponse/Shipment/Package/Activity");
                if ($activityTags) {
                    $index = 1;
                    foreach ($activityTags as $activityTag) {
                        $addressArr = [];
                        if (isset($activityTag->ActivityLocation->Address->City)) {
                            $addressArr[] = (string)$activityTag->ActivityLocation->Address->City;
                        }
                        if (isset($activityTag->ActivityLocation->Address->StateProvinceCode)) {
                            $addressArr[] = (string)$activityTag->ActivityLocation->Address->StateProvinceCode;
                        }
                        if (isset($activityTag->ActivityLocation->Address->CountryCode)) {
                            $addressArr[] = (string)$activityTag->ActivityLocation->Address->CountryCode;
                        }
                        $dateArr = [];
                        $date = (string)$activityTag->Date;
                        //YYYYMMDD
                        $dateArr[] = substr($date, 0, 4);
                        $dateArr[] = substr($date, 4, 2);
                        $dateArr[] = substr($date, -2, 2);

                        $timeArr = [];
                        $time = (string)$activityTag->Time;
                        //HHMMSS
                        $timeArr[] = substr($time, 0, 2);
                        $timeArr[] = substr($time, 2, 2);
                        $timeArr[] = substr($time, -2, 2);

                        if ($index === 1) {
                            $resultArr['status'] = (string)$activityTag->Status->StatusType->Description;
                            $resultArr['deliverydate'] = implode('-', $dateArr);
                            //YYYY-MM-DD
                            $resultArr['deliverytime'] = implode(':', $timeArr);
                            //HH:MM:SS
                            $resultArr['deliverylocation'] = (string)$activityTag->ActivityLocation->Description;
                            $resultArr['signedby'] = (string)$activityTag->ActivityLocation->SignedForByName;
                            if ($addressArr) {
                                $resultArr['deliveryto'] = implode(', ', $addressArr);
                            }
                        } else {
                            $tempArr = [];
                            $tempArr['activity'] = (string)$activityTag->Status->StatusType->Description;
                            $tempArr['deliverydate'] = implode('-', $dateArr);
                            //YYYY-MM-DD
                            $tempArr['deliverytime'] = implode(':', $timeArr);
                            //HH:MM:SS
                            if ($addressArr) {
                                $tempArr['deliverylocation'] = implode(', ', $addressArr);
                            }
                            $packageProgress[] = $tempArr;
                        }
                        $index++;
                    }
                    $resultArr['progressdetail'] = $packageProgress;
                }
            } else {
                $arr = $xml->getXpath("//TrackResponse/Response/Error/ErrorDescription/text()");
                $errorTitle = (string)$arr[0][0];
            }
        }

        if (!$this->_result) {
            $this->_result = $this->_trackFactory->create();
        }

        if ($resultArr) {
            $tracking = $this->_trackStatusFactory->create();
            $tracking->setCarrier('ups');
            $tracking->setCarrierTitle($this->getConfigData('title'));
            $tracking->setTracking($trackingValue);
            $tracking->addData($resultArr);
            $this->_result->append($tracking);
        } else {
            $error = $this->_trackErrorFactory->create();
            $error->setCarrier('ups');
            $error->setCarrierTitle($this->getConfigData('title'));
            $error->setTracking($trackingValue);
            $error->setErrorMessage($errorTitle);
            $this->_result->append($error);
        }

        return $this->_result;
    }

_sendShipmentAcceptRequest()

_sendShipmentAcceptRequest ( Element  $shipmentConfirmResponse )

protected

Send and process shipment accept request

Parameters

Element

$shipmentConfirmResponse

Returns

\Magento\Framework\DataObject

Definition at line 1439 of file Carrier.php.

    {
        $xmlRequest = $this->_xmlElFactory->create(
            ['data' => '<?xml version = "1.0" ?><ShipmentAcceptRequest/>']
        );
        $request = $xmlRequest->addChild('Request');
        $request->addChild('RequestAction', 'ShipAccept');
        $xmlRequest->addChild('ShipmentDigest', $shipmentConfirmResponse->ShipmentDigest);
        $debugData = ['request' => $this->filterDebugData($this->_xmlAccessRequest) . $xmlRequest->asXML()];

        try {
            $client = $this->httpClientFactory->create();
            $client->post($this->getShipAcceptUrl(), $this->_xmlAccessRequest . $xmlRequest->asXML());
            $xmlResponse = $client->getBody();
            $debugData['result'] = $xmlResponse;
            $this->_setCachedQuotes($xmlRequest, $xmlResponse);
        } catch (\Throwable $e) {
            $debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
            $xmlResponse = '';
        }

        try {
            $response = $this->_xmlElFactory->create(['data' => $xmlResponse]);
        } catch (\Throwable $e) {
            $debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
        }

        $result = new \Magento\Framework\DataObject();
        if (isset($response->Error)) {
            $result->setErrors((string)$response->Error->ErrorDescription);
        } else {
            $shippingLabelContent = (string)$response->ShipmentResults->PackageResults->LabelImage->GraphicImage;
            $trackingNumber = (string)$response->ShipmentResults->PackageResults->TrackingNumber;

            $result->setShippingLabelContent(base64_decode($shippingLabelContent));
            $result->setTrackingNumber($trackingNumber);
        }

        $this->_debug($debugData);

        return $result;
    }

_setFreeMethodRequest()

_setFreeMethodRequest (   $freeMethod )

protected

Set free method request

Parameters

string

$freeMethod

Returns

void

Definition at line 429 of file Carrier.php.

    {
        $r = $this->_rawRequest;

        $weight = $this->getTotalNumOfBoxes($r->getFreeMethodWeight());
        $weight = $this->_getCorrectWeight($weight);
        $r->setWeight($weight);
        $r->setAction($this->configHelper->getCode('action', 'single'));
        $r->setProduct($freeMethod);
    }

collectRates()

collectRates

(

RateRequest

$request

)

Collect and get rates/errors

Parameters

RateRequest

$request

Returns

Result|Error|bool

Implements AbstractCarrierInterface.

Definition at line 209 of file Carrier.php.

    {
        $this->setRequest($request);
        if (!$this->canCollectRates()) {
            return $this->getErrorMessage();
        }

        $this->setRequest($request);
        $this->_result = $this->_getQuotes();
        $this->_updateFreeMethodQuote($request);

        return $this->getResult();
    }

getAllowedMethods()

getAllowedMethods

(

)

Get allowed shipping methods

Returns

array

Implements CarrierInterface.

Definition at line 1210 of file Carrier.php.

    {
        $allowed = explode(',', $this->getConfigData('allowed_methods'));
        $arr = [];
        $isByCode = $this->getConfigData('type') == 'UPS_XML';
        foreach ($allowed as $code) {
            $arr[$code] = $isByCode ? $this->getShipmentByCode($code) : $this->configHelper->getCode('method', $code);
        }

        return $arr;
    }

getContainerTypes()

getContainerTypes

(

\Magento\Framework\DataObject

$params = null

)

Return container types of carrier

Parameters

\Magento\Framework\DataObject | null

$params

Returns

array|bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 1579 of file Carrier.php.

    {
        if ($params === null) {
            return $this->_getAllowedContainers($params);
        }
        $method = $params->getMethod();
        $countryShipper = $params->getCountryShipper();
        $countryRecipient = $params->getCountryRecipient();

        if ($countryShipper == self::USA_COUNTRY_ID && $countryRecipient == self::CANADA_COUNTRY_ID ||
            $countryShipper == self::CANADA_COUNTRY_ID && $countryRecipient == self::USA_COUNTRY_ID ||
            $countryShipper == self::MEXICO_COUNTRY_ID && $countryRecipient == self::USA_COUNTRY_ID && $method == '11'
        ) {
            $containerTypes = [];
            if ($method == '07' || $method == '08' || $method == '65') {
                // Worldwide Expedited
                if ($method != '08') {
                    $containerTypes = [
                        '01' => __('UPS Letter Envelope'),
                        '24' => __('UPS Worldwide 25 kilo'),
                        '25' => __('UPS Worldwide 10 kilo'),
                    ];
                }
                $containerTypes = $containerTypes + [
                    '03' => __('UPS Tube'),
                    '04' => __('PAK'),
                    '2a' => __('Small Express Box'),
                    '2b' => __('Medium Express Box'),
                    '2c' => __('Large Express Box'),
                ];
            }

            return ['00' => __('Customer Packaging')] + $containerTypes;
        } elseif ($countryShipper == self::USA_COUNTRY_ID &&
            $countryRecipient == self::PUERTORICO_COUNTRY_ID &&
            ($method == '03' ||
            $method == '02' ||
            $method == '01')
        ) {
            // Container types should be the same as for domestic
            $params->setCountryRecipient(self::USA_COUNTRY_ID);
            $containerTypes = $this->_getAllowedContainers($params);
            $params->setCountryRecipient($countryRecipient);

            return $containerTypes;
        }

        return $this->_getAllowedContainers($params);
    }

getContainerTypesAll()

getContainerTypesAll

(

)

Return all container types of carrier

Returns

array|bool

Definition at line 1634 of file Carrier.php.

    {
        $codes = $this->configHelper->getCode('container');
        $descriptions = $this->configHelper->getCode('container_description');
        $result = [];
        foreach ($codes as $key => &$code) {
            $result[$code] = $descriptions[$key];
        }

        return $result;
    }

getContainerTypesFilter()

getContainerTypesFilter

(

)

Return structured data of containers witch related with shipping methods

Returns

array|bool

Definition at line 1651 of file Carrier.php.

    {
        return $this->configHelper->getCode('containers_filter');
    }

getCustomizableContainerTypes()

getCustomizableContainerTypes

(

)

Get Container Types, that could be customized for UPS carrier

Returns

array

Implements AbstractCarrierInterface.

Definition at line 1690 of file Carrier.php.

    {
        $result = [];
        $containerTypes = $this->configHelper->getCode('container');
        foreach (parent::getCustomizableContainerTypes() as $containerType) {
            $result[$containerType] = $containerTypes[$containerType];
        }

        return $result;
    }

getDeliveryConfirmationTypes()

getDeliveryConfirmationTypes

(

\Magento\Framework\DataObject

$params = null

)

Return delivery confirmation types of carrier

Parameters

\Magento\Framework\DataObject | null

$params

Returns

array|bool

Definition at line 1662 of file Carrier.php.

    {
        $countryRecipient = $params != null ? $params->getCountryRecipient() : null;
        $deliveryConfirmationTypes = [];
        switch ($this->_getDeliveryConfirmationLevel($countryRecipient)) {
            case self::DELIVERY_CONFIRMATION_PACKAGE:
                $deliveryConfirmationTypes = [
                    1 => __('Delivery Confirmation'),
                    2 => __('Signature Required'),
                    3 => __('Adult Signature Required'),
                ];
                break;
            case self::DELIVERY_CONFIRMATION_SHIPMENT:
                $deliveryConfirmationTypes = [1 => __('Signature Required'), 2 => __('Adult Signature Required')];
                break;
            default:
                break;
        }
        array_unshift($deliveryConfirmationTypes, __('Not Required'));

        return $deliveryConfirmationTypes;
    }

getResponse()

getResponse

(

)

Get tracking response

Returns

string

Definition at line 1180 of file Carrier.php.

    {
        $statuses = '';
        if ($this->_result instanceof \Magento\Shipping\Model\Tracking\Result) {
            $trackings = $this->_result->getAllTrackings();
            if ($trackings) {
                foreach ($trackings as $tracking) {
                    $data = $tracking->getAllData();
                    if ($data) {
                        if (isset($data['status'])) {
                            $statuses .= __($data['status']);
                        } else {
                            $statuses .= __($data['error_message']);
                        }
                    }
                }
            }
        }
        if (empty($statuses)) {
            $statuses = __('Empty response');
        }

        return $statuses;
    }

getResult()

getResult

(

)

Get result of request

Returns

Result

Definition at line 399 of file Carrier.php.

    {
        return $this->_result;
    }

getShipAcceptUrl()

getShipAcceptUrl

(

)

Get ship accept url

Returns

string

Definition at line 1487 of file Carrier.php.

    {
        if ($this->getConfigData('is_account_live')) {
            $url = $this->_liveUrls['ShipAccept'];
        } else {
            $url = $this->_defaultUrls['ShipAccept'];
        }

        return $url;
    }

getShipConfirmUrl()

getShipConfirmUrl

(

)

Get ship confirm url

Returns

string

Definition at line 1554 of file Carrier.php.

    {
        $url = $this->getConfigData('url');
        if (!$url) {
            if ($this->getConfigData('is_account_live')) {
                $url = $this->_liveUrls['ShipConfirm'];

                return $url;
            } else {
                $url = $this->_defaultUrls['ShipConfirm'];

                return $url;
            }
        }

        return $url;
    }

getShipmentByCode()

getShipmentByCode	(		$code,
			$origin = null
	)

Get shipment by code

Parameters

string	$code
string	$origin

Returns

array|bool

Definition at line 505 of file Carrier.php.

    {
        if ($origin === null) {
            $origin = $this->getConfigData('origin_shipment');
        }
        $arr = $this->configHelper->getCode('originShipment', $origin);
        if (isset($arr[$code])) {
            return $arr[$code];
        } else {
            return false;
        }
    }

getTracking()

getTracking

(

$trackings

)

Get tracking

Parameters

string|string[]

$trackings

Returns

Result

Definition at line 945 of file Carrier.php.

    {
        if (!is_array($trackings)) {
            $trackings = [$trackings];
        }

        if ($this->getConfigData('type') == 'UPS') {
            $this->_getCgiTracking($trackings);
        } elseif ($this->getConfigData('type') == 'UPS_XML') {
            $this->setXMLAccessRequest();
            $this->_getXmlTracking($trackings);
        }

        return $this->_result;
    }

setRequest()

setRequest

(

RateRequest

$request

)

Prepare and set request to this instance

Parameters

RateRequest

$request

Returns

$this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity) @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 232 of file Carrier.php.

    {
        $this->_request = $request;

        $rowRequest = new \Magento\Framework\DataObject();

        if ($request->getLimitMethod()) {
            $rowRequest->setAction($this->configHelper->getCode('action', 'single'));
            $rowRequest->setProduct($request->getLimitMethod());
        } else {
            $rowRequest->setAction($this->configHelper->getCode('action', 'all'));
            $rowRequest->setProduct('GND' . $this->getConfigData('dest_type'));
        }

        if ($request->getUpsPickup()) {
            $pickup = $request->getUpsPickup();
        } else {
            $pickup = $this->getConfigData('pickup');
        }
        $rowRequest->setPickup($this->configHelper->getCode('pickup', $pickup));

        if ($request->getUpsContainer()) {
            $container = $request->getUpsContainer();
        } else {
            $container = $this->getConfigData('container');
        }
        $rowRequest->setContainer($this->configHelper->getCode('container', $container));

        if ($request->getUpsDestType()) {
            $destType = $request->getUpsDestType();
        } else {
            $destType = $this->getConfigData('dest_type');
        }
        $rowRequest->setDestType($this->configHelper->getCode('dest_type', $destType));

        if ($request->getOrigCountry()) {
            $origCountry = $request->getOrigCountry();
        } else {
            $origCountry = $this->_scopeConfig->getValue(
                \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_COUNTRY_ID,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                $request->getStoreId()
            );
        }

        $rowRequest->setOrigCountry($this->_countryFactory->create()->load($origCountry)->getData('iso2_code'));

        if ($request->getOrigRegionCode()) {
            $origRegionCode = $request->getOrigRegionCode();
        } else {
            $origRegionCode = $this->_scopeConfig->getValue(
                \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_REGION_ID,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                $request->getStoreId()
            );
        }
        if (is_numeric($origRegionCode)) {
            $origRegionCode = $this->_regionFactory->create()->load($origRegionCode)->getCode();
        }
        $rowRequest->setOrigRegionCode($origRegionCode);

        if ($request->getOrigPostcode()) {
            $rowRequest->setOrigPostal($request->getOrigPostcode());
        } else {
            $rowRequest->setOrigPostal(
                $this->_scopeConfig->getValue(
                    \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_ZIP,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                    $request->getStoreId()
                )
            );
        }

        if ($request->getOrigCity()) {
            $rowRequest->setOrigCity($request->getOrigCity());
        } else {
            $rowRequest->setOrigCity(
                $this->_scopeConfig->getValue(
                    \Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_CITY,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                    $request->getStoreId()
                )
            );
        }

        if ($request->getDestCountryId()) {
            $destCountry = $request->getDestCountryId();
        } else {
            $destCountry = self::USA_COUNTRY_ID;
        }

        //for UPS, puero rico state for US will assume as puerto rico country
        if ($destCountry == self::USA_COUNTRY_ID && ($request->getDestPostcode() == '00912' ||
            $request->getDestRegionCode() == self::PUERTORICO_COUNTRY_ID)
        ) {
            $destCountry = self::PUERTORICO_COUNTRY_ID;
        }

        // For UPS, Guam state of the USA will be represented by Guam country
        if ($destCountry == self::USA_COUNTRY_ID && $request->getDestRegionCode() == self::GUAM_REGION_CODE) {
            $destCountry = self::GUAM_COUNTRY_ID;
        }

        $country = $this->_countryFactory->create()->load($destCountry);
        $rowRequest->setDestCountry($country->getData('iso2_code') ?: $destCountry);

        $rowRequest->setDestRegionCode($request->getDestRegionCode());

        if ($request->getDestPostcode()) {
            $rowRequest->setDestPostal($request->getDestPostcode());
        }

        $weight = $this->getTotalNumOfBoxes($request->getPackageWeight());

        $weight = $this->_getCorrectWeight($weight);

        $rowRequest->setWeight($weight);
        if ($request->getFreeMethodWeight() != $request->getPackageWeight()) {
            $rowRequest->setFreeMethodWeight($request->getFreeMethodWeight());
        }

        $rowRequest->setValue($request->getPackageValue());
        $rowRequest->setValueWithDiscount($request->getPackageValueWithDiscount());

        if ($request->getUpsUnitMeasure()) {
            $unit = $request->getUpsUnitMeasure();
        } else {
            $unit = $this->getConfigData('unit_of_measure');
        }
        $rowRequest->setUnitMeasure($unit);
        $rowRequest->setIsReturn($request->getIsReturn());
        $rowRequest->setBaseSubtotalInclTax($request->getBaseSubtotalInclTax());

        $this->_rawRequest = $rowRequest;

        return $this;
    }

setXMLAccessRequest()

setXMLAccessRequest ( )

protected

Set xml access request

Returns

void

Definition at line 966 of file Carrier.php.

    {
        $userId = $this->getConfigData('username');
        $userIdPass = $this->getConfigData('password');
        $accessKey = $this->getConfigData('access_license_number');

        $this->_xmlAccessRequest = <<<XMLAuth
<?xml version="1.0" ?>
<AccessRequest xml:lang="en-US">
  <AccessLicenseNumber>$accessKey</AccessLicenseNumber>
  <UserId>$userId</UserId>
  <Password>$userIdPass</Password>
</AccessRequest>
XMLAuth;
    }

Field Documentation

$_baseCurrencyRate

$_baseCurrencyRate

protected

Definition at line 66 of file Carrier.php.

$_code

$_code = self::CODE

protected

Definition at line 45 of file Carrier.php.

$_customizableContainerTypes

$_customizableContainerTypes = ['CP', 'CSP']

protected

Definition at line 107 of file Carrier.php.

$_debugReplacePrivateDataKeys

$_debugReplacePrivateDataKeys

protected

Initial value:

= [
        'UserId', 'Password', 'AccessLicenseNumber'
    ]

Definition at line 127 of file Carrier.php.

$_defaultCgiGatewayUrl

$_defaultCgiGatewayUrl = 'http://www.ups.com:80/using/services/rave/qcostcgi.cgi'

protected

Definition at line 80 of file Carrier.php.

$_defaultUrls

$_defaultUrls

protected

Initial value:

= [
        'ShipConfirm' => 'https:
        'ShipAccept' => 'https:
    ]

Definition at line 87 of file Carrier.php.

$_liveUrls

$_liveUrls

protected

Initial value:

= [
        'ShipConfirm' => 'https:
        'ShipAccept' => 'https:
    ]

Definition at line 97 of file Carrier.php.

$_localeFormat

$_localeFormat

protected

Definition at line 112 of file Carrier.php.

$_logger

$_logger

protected

Definition at line 117 of file Carrier.php.

$_request

$_request

protected

Definition at line 52 of file Carrier.php.

$_result

$_result

protected

Definition at line 59 of file Carrier.php.

$_xmlAccessRequest

$_xmlAccessRequest

protected

Definition at line 73 of file Carrier.php.

$configHelper

$configHelper

protected

Definition at line 122 of file Carrier.php.

CODE

const CODE = 'ups'

Definition at line 31 of file Carrier.php.

DELIVERY_CONFIRMATION_PACKAGE

const DELIVERY_CONFIRMATION_PACKAGE = 2

Definition at line 38 of file Carrier.php.

DELIVERY_CONFIRMATION_SHIPMENT

const DELIVERY_CONFIRMATION_SHIPMENT = 1

Delivery Confirmation level based on origin/destination

Definition at line 36 of file Carrier.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-ups/Model/Carrier.php