function commerce_ups_build_rate_request in Commerce UPS 7.2

Same name and namespace in other branches

1. 7 commerce_ups.xml.inc \commerce_ups_build_rate_request()

This builds the XML to submit to UPS for rates.

Here's a decent sample of what the resulting XML should look like: http://sameers.me/2011/01/21/ups-rate-request-sample/

1 call to commerce_ups_build_rate_request()

commerce_ups_service_rate_order in ./commerce_ups.module

Shipping service callback: returns a base price array for a shipping service calculated for the given order.

File

includes/commerce_ups.xml.inc, line 30

Handles XML-related stuff for Commerce UPS module.

Code

function commerce_ups_build_rate_request($order) {
  $api_vars = commerce_ups_decrypt_vars(TRUE);
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);

  // Determine the shipping profile reference field name for the order.
  $field_name = commerce_physical_order_shipping_field_name($order);
  $shipping_profile = $order_wrapper->{$field_name}
    ->value();

  // Prepare the shipping address for use in the request.
  if (!empty($order_wrapper->{$field_name}->commerce_customer_address)) {
    $shipping_address = $order_wrapper->{$field_name}->commerce_customer_address
      ->value();
  }
  else {
    $field = field_info_field($field_name);
    $instance = field_info_instance('commerce_customer_profile', 'commerce_customer_address', 'shipping');
    $shipping_address = addressfield_default_values($field, $instance);
  }
  $ups_pickupschedule = variable_get('commerce_ups_pick_up_schedule');

  // This returns $weight['unit'] and $weight['weight'].
  $weight = commerce_physical_order_weight($order, 'lb');

  // This returns $volume['unit'] and $weight['volume'].
  $volume = commerce_physical_order_volume($order, 'in');
  $default_package_volume = variable_get('commerce_ups_default_package_size_length', '0') * variable_get('commerce_ups_default_package_size_width', '0') * variable_get('commerce_ups_default_package_size_height', '0');

  /* If there is no default package volume, we cannot calculate the number of packages and there is no reason to send to UPS */
  if ($default_package_volume == 0) {
    drupal_set_message(t('There was an error with the UPS configuration.'), 'error', FALSE);
    watchdog('commerce_ups', 'The default measurements for the commerce_ups module is empty or is set to zero. Please set the default package dimensions in the settings page for the commerce_ups module. Without the default measurements this module cannot calculate the number of packages and UPS rates will not be displayed.', array(), WATCHDOG_ALERT);
    return FALSE;
  }

  /* If there is no total volume or weight for the order, there is no reason to send the request to UPS */
  if ($volume['volume'] == NULL || $weight['weight'] == NULL) {
    return FALSE;
  }

  // Calculate the number of packages based on the following logic:
  //   1. Total order volume / Default package volume (as set in the UI).
  //   2. If the weight per package is greater than 150lbs, then add another
  //      package until the weight per package is less than 150lbs.
  $number_of_packages = ceil($volume['volume'] / $default_package_volume);
  $weight_per_package = $weight['weight'] / $number_of_packages;
  while ($weight_per_package > 150) {
    $number_of_packages++;
    $weight_per_package = $weight['weight'] / $number_of_packages;
  }

  /* Pickup Schedule */
  $schedule_code = variable_get('commerce_ups_pick_up_schedule');

  /* Ship To - Customer Shipping Address */
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);

  // Prepare the shipping address for use in the request.
  if (!empty($order_wrapper->commerce_customer_shipping->commerce_customer_address)) {
    $shipping_address = $order_wrapper->commerce_customer_shipping->commerce_customer_address
      ->value();
  }
  $rating_request = new SimpleXMLElement('<RatingServiceSelectionRequest/>');
  $request = $rating_request
    ->addChild('Request');
  $transaction_reference = $request
    ->addChild('TransactionReference');
  $transaction_reference->CustomerContext = 'Bare Bones Rate Request';
  $transaction_reference->XpciVersion = '1.0001';
  $request->RequestAction = 'Rate';
  $request->RequestOption = 'Shop';
  $request->pickupType->code = $schedule_code;
  $shipment = $rating_request
    ->addChild('Shipment');
  if (variable_get('commerce_ups_negotiated_rates', FALSE)) {
    $rate_information = $shipment
      ->addChild('RateInformation');
    $rate_information
      ->addChild('NegotiatedRatesIndicator');
  }
  $shipper = $shipment
    ->addChild('Shipper');
  $shipper_address = $shipper
    ->addChild('Address');
  $shipper_address->PostalCode = variable_get('commerce_ups_postal_code', '');
  $shipper_address->CountryCode = variable_get('commerce_ups_country_code', '');
  $shipper->ShipperNumber = $api_vars['ups_accountid'];
  $shipto = $shipment
    ->addChild('ShipTo');
  $shipto_address = $shipto
    ->addChild('Address');
  $shipto_address->StateProvinceCode = $shipping_address['administrative_area'];
  $shipto_address->PostalCode = $shipping_address['postal_code'];
  $shipto_address->CountryCode = $shipping_address['country'];
  if (variable_get('commerce_ups_shipto_residential', FALSE)) {
    $shipto_address->ResidentialAddressIndicator = 'true';
  }
  $shipfrom = $shipment
    ->addChild('ShipFrom');
  $shipfrom_address = $shipfrom
    ->addChild('Address');
  $shipfrom_address->StateProvinceCode = variable_get('commerce_ups_state', '');
  $shipfrom_address->PostalCode = variable_get('commerce_ups_postal_code', '');
  $shipfrom_address->CountryCode = variable_get('commerce_ups_country_code', '');
  $shipfrom->ResidentialAddressIndicator = '';
  $package_number = 1;
  for ($i = 1; $package_number <= $number_of_packages; $i++) {
    $package = $shipment
      ->addChild('Package');
    $package->PackagingType->Code = variable_get('commerce_ups_packaging', '02');
    $dimensions = $package
      ->addChild('Dimensions');
    $dimensions->UnitOfMeasurement->Code = 'IN';
    $dimensions->Length = variable_get('commerce_ups_default_package_size_length', '0');
    $dimensions->Width = variable_get('commerce_ups_default_package_size_width', '0');
    $dimensions->Height = variable_get('commerce_ups_default_package_size_height', '0');
    $package_weight = $package
      ->addChild('PackageWeight');
    $package_weight->UnitOfMeasurement->Code = 'LBS';

    /* If the weight is less than 0.1, set it to 0.1. I tried to find some "official" documentation
     *   for this on the UPS site, but could not. I did find that other ecommerce platforms are
     *   using this same logic though, I think it is safe for now. mta
     */
    $package_weight->Weight = max(array(
      0.1,
      $weight['weight'] / $number_of_packages,
    ));
    $package_number++;
  }

  // Allow other modules to alter the rate request.
  drupal_alter('commerce_ups_build_rate_request', $rating_request, $order);

  // Prepend the access request XML.
  $xml = commerce_ups_build_access_request($order) . $rating_request
    ->asXML();
  return $xml;
}