Customer Pickup Control for StoreFront 7
by Structured Solutions

The Customer Pickup Control allows you to add customer pickup shipping options. Each pickup option can have a unique name, address and fixed shipping cost.

Features
Tables of Contents

Installation Instructions

Follow these steps to install the Customer Pickup Control:

  1. Run the Customer Pickup Control installer to extract the product files to a directory on your local computer. By default the installer will extract the files to a folder on your desktop called Customer Pickup Control.
  2. Copy the files from the bin directory of the Customer Pickup Control folder to the bin directory of your website.
    Some stores are configured to use a separate bin directory for secure checkout pages such as Shipping.aspx. If your store is configured this way, copy the files from the bin directory of the Customer Pickup Control folder to the secure bin directory of your web site.

  3. Make a backup copy of Shipping.aspx, and ShipSummary.aspx located in the ssl directory.
  4. If you allow shipping to multiple addresses, then backup MultiShip.aspx and MultiShip.aspx.vb also located in the ssl directory.
     
    Do not keep backup copies of files that end with the ".vb" extension anywhere in the store directory tree. This will confuse the compiler and prevent these modifications from taking effect.

  5. Open Shipping.aspx with a text editor and add this text at the top of the file:
    <%@ Register TagPrefix= "sfaddons" Namespace= "StructuredSolutions.StoreFront7.WebControls" Assembly="StructuredSolutions.StoreFront7.WebControls.CustomerPickup" %>
  6. Now locate this line near line 65:
    <form id=Form2 method=post runat="server">
  7. Add the lines shown in bold immediately after the line you found:
    <form id=Form2 method=post runat="server">
    <sfaddons:customerpickup id="CustomerPickup1" runat="server"
        Address1="123 Main Street"
        City="City"
        State="AL"
        Zip="12345"
        Country="US"
        Email="info@company.com"
        Phone="123-555-1212">
    </sfaddons:customerpickup>
  8. Change the values of Address1, City, State, Zip, Country, Email, and Phone to match the address of the pickup location. These are the minimum address attributes that you must define for each pickup location.
  9. If you have more than one pickup location, then insert the lines shown in bold above for each address, using a unique ID for each CustomerPickup control.
  10. Save the changes and close the file.
  11. Open ShipSummary.aspx with a text editor and add this text at the top of the file (note that using TagPrefix="sfaddons1" lets you use both Customer Pickup and the Select Carrier Patch on the same page).
    <%@ Register TagPrefix="sfaddons1" Namespace="StructuredSolutions.StoreFront7.WebControls" Assembly="StructuredSolutions.StoreFront7.WebControls.CustomerPickup" %>
  12. Now locate this line near line 65:
    <form id=Form2 method=post runat="server">
  13. Add the line shown in bold immediately after the line you found (note that the remaining CustomerPickup attributes are not required in ShipSummary.aspx and will be ignored if you enter them on this page):
    <form id=Form2 method=post runat="server">
    <sfaddons1:customerpickup id="CustomerPickup1" runat="server" />
  14. You do not need more than one Customer Pickup Control on the ShipSummary.aspx page even if you create multiple customer pickup locations in Shipping.aspx or MultiShip.aspx.
  15. Save the changes and close the file.

This completes the typical installation that supports shipping the entire order to a single location. If you allow shipping to multiple addresses, then complete the following steps.

  1. Open MultiShip.aspx with a text editor and repeat steps 3-8 above.
  2. Open MultiShip.aspx.vb with a text editor and locate these lines of code about 1/2 through the file:
    objAddressLabel.AddressSource = objMultiShip.GetAddress(objDropDown.SelectedItem.Value, m_objcustomer)
    objOrder.AddOrderAddress(objMultiShip.SetItemToAddress(objRepeaterItem.ItemIndex, objDropDown.SelectedItem.Value, m_objcustomer))
  3. Add the code shown in bold around the 2 lines that you found:
    '===================================================
    ' Customer Pickup Control modification
    If Not objMultiShip.GetAddress(objDropDown.SelectedItem.Value, m_objCustomer) Is Nothing Then
        objAddressLabel.AddressSource = objMultiShip.GetAddress(objDropDown.SelectedItem.Value, m_objcustomer)
        objOrder.AddOrderAddress(objMultiShip.SetItemToAddress(objRepeaterItem.ItemIndex, objDropDown.SelectedItem.Value, m_objcustomer))
    End If
    '===================================================
  4. Save the change and close the file.
  5. Compile your site by loading the CompileSite.aspx page in a browser, or by selecting Compile Components from the StoreFront client menu.

Back to top

User's Guide

Customer Pickup options are displayed on the Shipping (Shipping.aspx) and Multiple Address Shipping (MultiShip.aspx) pages as additional addresses in the "Ship To:" drop down list. By default, each pickup option will be labeled "Customer Pickup", but you can change this using the NickName attribute. The pickup address will be displayed as a standard address, although the customer will not be able edit the component parts such as City or State.

When the customer reaches the Shipping Summary (ShipSummary.aspx) page, each pickup location will labeled "Customer Pickup" (in the lblBackupShip label). If there is a cost associated with the pickup location this is also shown. For example "Customer Pickup ($5.95)". All other shipping options are hidden.

In the confirmation emails and order detail pages, each pickup location will have the shipping carrier set to "PICKUP" and the shipping method set to "Customer Pickup".

Back to top

Control Documentation

The <sfaddons:CustomerPickup> tag is used in the Shipping.aspx, MultiShip.aspx, and ShipSummary.aspx pages to add customer pickup shipping locations. The table below lists the attributes that can be added to the <sfaddons:CustomerPickup> tag to define the pickup location. Multiple attributes can be specified just like they are for standard HTML tags like <table>. Moreover, you do not need to recompile your store to see your changes. Just save your change and reload the page in your browser. This makes experimenting very easy.

Most of the attributes below are used to create the pickup address. To pass the verification routines of the Shipping.aspx and MultiShip.aspx pages, at least the following address fields must be defined for each pickup location: Address1, City, State, Country, Email, and Phone.

<sfaddons:CustomerPickup> Tag Attributes
Attribute Description Example
Address1 First line of the street address for the pickup location.

Default: no default

 To specify a street address for the pickup location:

<sfaddons:CustomerPickup Address1="123 Main Street" ...>
Address2 Second line of the street address for the pickup location.

Default: no default

 To specify a suite number for the pickup location:

<sfaddons:CustomerPickup Address2="Suite 123-B" ...>
City The city of the pickup location.

Default: no default

 To specify the city of the pickup location:

<sfaddons:CustomerPickup City="Anchorage" ...>
Company The company name for the pickup location.

Default: no default

 To specify a company name for the pickup location:

<sfaddons:CustomerPickup Company="Ringling Bros" ...>
Cost The shipping cost for the pickup location. If you specify a cost, it will be displayed on the ShipSummary.aspx page as part of the Customer Pickup location label using localized currency symbols. Do not use any currency symbols when you enter this value.

Default: 0

 To specify the shipping cost for the pickup location:

<sfaddons:CustomerPickup Cost="5.95" ...>
Country The 2 letter abbreviation for the country of the pickup location. The value must correspond to one of the supported countries for your store.

Default: first country in the list of supported countries for your store.

 To specify the country of the pickup location:

<sfaddons:CustomerPickup Country="US" ...>
Email Email address for the pickup location.

Default: no default

 To specify the email address of the contact for the pickup location:

<sfaddons:CustomerPickup Email="info@company.com" ...>
Enabled

A Boolean value (True or False) which enables or disables this control. When Enabled="False", this control will have no effect. This can be useful if you are troubleshooting the ShipSummary page with StoreFront support.

Default: True

 To prevent the customer pickup option from being displayed or affecting the page in any way:

<sfaddons:CustomerPickup Enabled="False"  ...>
Fax Fax number for the pickup location.

Default: no default

 To specify a fax number for the pickup location:

<sfaddons:CustomerPickup Fax="123-456-7890" ...>
FirstName First name of the contact for the pickup location.

Default: no default

 To specify first name of a contact for the pickup location:

<sfaddons:CustomerPickup FirstName="Customer" ...>
LastName Last name of the contact for the pickup location.

Default: no default

 To specify last name of a contact for the pickup location:

<sfaddons:CustomerPickup LastName="Service" ...>
MI Middle initial of the contact for the pickup location.

Default: no default

  
NickName On the Shipping.aspx and MultiShip.aspx pages, this is the name that is displayed in the drop down list of addresses. This is especially useful if you have more than one pickup location.

On the ShipSummary.aspx page, this name will be used as the label for the customer pickup cost.

Default: "Customer Pickup"

 To specify a descriptive pickup location name:

<sfaddons:CustomerPickup NickName="Customer Pickup - Outlet Center" ...>
Phone Phone number for the pickup location.

Default: no default

 To specify the phone number a contact for the pickup location:

<sfaddons:CustomerPickup Phone="123-456-7890" ...>
Prompt Prompt displayed next to address in Shipping.aspx or as first address in Multiship.aspx. Used to direct customer on required action.

Default.  "Select A Shipping Address From Address Book:"

 To specify a more accurate prompt:

<sfaddons:CustomerPickup Prompt="Select Address or Pickup Location:" ...>
State This is the 2 letter abbreviation for the state of the pickup location. The value must correspond to one of the supported states for your store. This is used to calculate state taxes if they apply.

Default: first state in the list of supported states for your store.

 To specify the state for the pickup location:

<sfaddons:CustomerPickup State="AL" ...>
UsePickupCost A Boolean (True or False) value that determines whether to use a fixed pickup cost or the calculated shipping cost to this pickup location. If True, then then fixed pickup cost will be used. If False, then the shipping cost to this pickup location will be calculated by StoreFront.

Default: True

 To use the shipping cost calculated by StoreFront:

<sfaddons:CustomerPickup UsePickupCost="False" ...>
Zip Zip code for the pickup location. This is used to calculate local taxes if they apply.

Default: no default

 To specify the zip code for the pickup location:

<sfaddons:CustomerPickup Zip="12345" ...>

Back to top

Removal Instructions

To remove the Customer Pickup Control from your store, you will need to restore Shipping.aspx, MultiShip.aspx, and ShipSummary.aspx. If you made a backup copy of these files prior to installing the add-on, then use that in the restore steps below. Otherwise, use the original versions from the StoreFront installation directory (typically. "C:\Program Files\StoreFront 6.0\Web").

  1. Copy the backup or original Shipping.aspx, MultiShip.aspx, and ShipSummary.aspx files to the ssl directory of your store.
  2. Remove StructuredSolutions.StoreFront7.WebControls.CustomerPickup.dll from the bin directory of your store.

Back to top

Support

Direct email support is available from support@structured-solutions.net for all licensed users of this add-on.

Back to top

Copyright © 2007, Structured Solutions. All rights reserved.