Order Status Uploads - CV3

From NewHaven Software Wiki

Contents 1 CMS 1.1 Data passed to CV3 2 Formatting the data for site display 2.1 CV3 array data in member_orderdetail.tpl 2.2 Website display 2.3 Template modifications 2.3.1 member_orderdetail.tpl

CMS

As part of the web service communications between CMS and CommerceV3 (CV3), CMS's eCMS Module uploads status (and tracking number where applicable) for orders that have been set as shipped and have not yet had their status uploaded.

CMS uploads three types of statuses:

• Shipped {date}
  • If all packages are shipped
• Processing
  • all new orders imported into CMS
    
  • Orders that are backordered
  • Orders with no packages
• Processing : Last Shipment {date}
  • This status will be set for orders that have more than one package and at least one (but not all) packages are shipped

Data passed to CV3

Example for illustration:

• Order shipped on 9/23/2014
• Recipient #1 shipped via UPS Ground with tracking number 123
• Recipient #2 shipped via FedEx 2-Day with tracking number 456

Status	Tracking
Shipped 9/23/2014	UPS: 123 ; FedEx: 456

Formatting the data for site display

CV3 array data in member_orderdetail.tpl

[order] => Array (
  [status] => Shipped 9/23/2014
  [tracking] => UPS: 789 ; FedEx: 456
  [order] => Array (
    [recipID] => Array (
      [ship_name] => John
      [ship_lastname] => Public
      ...
      [ship_method_name] => Fedex 2-day
      ...
      [detail_ship] => 30.00
    )
  )
)

Website display

Current Status: Shipped 9/23/2014

Tracking information for this order:

    UPS - 789

    Fedex - 456

Template modifications

member_orderdetail.tpl

  <input type="hidden" id="memberordertrack" value="{$order.tracking}" />

Used to put the $order.tracking value in the template so it can be accessed by Javascript.

      Current Status: {$order.status|lower|capitalize}<br>
{if $order.tracking != ''}
      <span id="memberOrderTracking">
        <b>Tracking information for this order:</b><br>
      </span>
{/if}

Used to display $order.status as uploaded by CMS, and include a tag for the tracking info if there is any in the PHP arrays. The Javascript function below to populate the info only runs if the span is present.

In js_bottom.js <syntaxhighlight lang="javascript"> //Parse uploaded order status tracking numbers. Mike::NHS::09252012 function parseOrderTracking() {

   var trackdata = document.getElementById('memberordertrack').value,
       tracks = [],
       baseURL = {
           'ups'   :   'http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=',
           'fedex' :   'http://www.fedex.com/Tracking?action=track&tracknumbers=',
           'usps'  :   'https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1='
       },
       i = 0,
       t = ,
       track = [],
       trackURL = ,
       trackSpan = jQuery('#memberOrderTracking'),
       output = ;
   
   // Split the tracking string.
   tracks = trackdata.split(' ; ');
   
   // Parse the string and output tracking URLs if a tracking number is present
   jQuery.each(tracks, function(i, t) {
       track = t.split(': ');
       if (track.length === 2) {
           trackURL = baseURL[track[0].toLowerCase()] + track[1];
           output = '    ' + track[0] + ' - <a href="' + trackURL + '" target="_blank">' + track[1] + '</a>
';
           
           trackSpan.append(output);
       } else {
           // No tracking number for the shipment, so we display nothing for this line.
       }
   });

}

$(document).ready(function() { </syntaxhighlight> ... <syntaxhighlight lang="javascript">

   // Only run parseOrderTracking if on member_orderdetail and tracking info is present
   if (jQuery('#memberOrderTracking').length !== 0) {
       parseOrderTracking();
   }

</syntaxhighlight> ... <syntaxhighlight lang="javascript"> }); // end of document.ready </syntaxhighlight>