Documentation of Advanced Shipping 2.6.2 extension for Magento 1.x by Owebia

Simple example: free shipping

Fees related to the destination

Use the wildcard character * or regular expressions

Fees related to customer group

You can use the name or ID of the customer groups.

Using formulas

Formulas can be used in properties conditions and fees.

Copying the property of another element

Using the function min()

Using the function range()

Using the function substr()

A variable of type string must be surrounded by single quotes unless the auto-quoting is used with the characters {{ and }}.

Using special functions

Using {foreach …} loops

Manipulate arrays

Using the function in_array()

Using the function in_array() avec des chaînes de caractères *

Using the function array_match_any()

Using the function array_match_all()

Other examples

Elements

There are three different types of configuration element:

• method: shipping method (default if not specified)
• data: data that can be used in one or more shipping methods (examples)
• meta: informative data (examples)

Properties

Each element has several properties:

• about: comment about the element
• type: element type (method, meta or data)

Properties specific to the element type method:

• label: name of shipping method
• description (visible only if the template displays it)
• enabled: shipping method enabled or not
• fees: shipping fees
• conditions: activation conditions
• shipto: countries (regions, postal codes) allowed for delivery
• billto: countries (regions, postal codes) allowed for billing
• origin: countries (regions, postal codes) allowed for origin
• customer_groups: customer groups allowed
• tracking_url (more informations)

See examples

Using properties of type address (shipto, billto and origin)

The country codes used are those of Magento (apparently they are the same as the ISO 3166-1 alpha-2 codes).
It is possible to specify region codes (only with shipto) or zip codes that you want to filter or exclude.

You can use the wildcard character * or regular expressions for postal codes.
A regular expression must start and end with the character /. If you want to use the characters (, ) or ., you must escape them with the character \ (ex: "FR(/^25\([0-9]{3}\)$/)").
You can use the insensitivity modifier (ex: "GB(/^PO.*$/i)").

See examples

The unique identifier

Each configuration element has a unique identifier. This identifier can be used to refer to the element.

Example:

Warning: to avoid conflicts, use only the characters a-z, A-Z, 0-9, - and _ for the unique identifier.
You should also avoid identifiers that already correspond to variable names (cart, product, item…).

Variables

When you use variables of type string, you must escape them with single quotes or use the auto-quoting syntax {{ }}.

The following variables can be used in formulas.

• The cart:
  • {cart.weight}: weight of goods
  • {cart.qty}: the quantity of items
  • {cart.price-tax+discount}: price excluding tax with discount
  • {cart.price+tax+discount}: price including tax with discount
  • {cart.price-tax-discount}: price excluding tax without discount
  • {cart.price+tax-discount}: price including tax without discount
  • {cart.coupon_code}: coupon code
  • {cart.free_shipping}: delivery offered (by rules in Magento) [true/false]
  • {cart.weight_unit}
  • {cart.weight_for_charge}: weight of goods whose delivery is not offered (by cart pricing rules in Magento)
• The quote:
  • {quote.subtotal}: subtotal (excluding tax)
  • {quote.subtotal_with_discount}: subtotal (excluding tax) with discount
  • {quote.grand_total}: total (including tax) with discount
  • {quote.base_subtotal}: subtotal (excluding tax) in base currency
  • {quote.base_subtotal_with_discount}: subtotal (excluding tax) with discount in base currency
  • {quote.base_grand_total}: total (including tax) with discount in base currency
• The customer group:
  • {customer_group.id}: id of customer group
  • {customer_group.code}: name of customer group
  • {customer_group.*}: property of the customer group (ex: {customer_group.tax_class_id})
• The customer:
  • {customer.id}: id of customer
  • {customer.attribute.*}: attribute of the customer (ex: lastname, firstname, group_id…)
  • {customer.attribute.*.value}: in case of an attribute of type selection list, {customer.attribute.*} returns the id, to get the value, you have to use {customer.attribute.*.value}
  • {customer.*}: same as {customer.attribute.*}, unless the variable is already defined (ex: {customer.id} is already defined)
• Custom Variables (since Magento 1.4.0.1):
  • {customvar.*}: custome variable defined in Magento (ex: {customvar.my_var})
• The delivery address:
  • {shipto.country_name}
  • {shipto.country_id}: the country code
  • {shipto.region_id}
  • {shipto.region_code}
  • {shipto.street}
  • {shipto.city}
  • {shipto.postcode}
• The billing address:
  • {billto.country_name}
  • {billto.country_id}: the country code
  • {billto.postcode}
  • {billto.*}: property of the billing address (ex: {billto.city})
• The origin address:
  • {origin.country_name}
  • {origin.country_id}: the country code
  • {origin.region_id}
  • {origin.city}
  • {origin.postcode}
• The store:
  • {store.id} {store.code} {store.name} {store.address} {store.phone}
• The current date:
  • {date.timestamp}: UNIX timestamp of the current date
  • {date.year} {date.month} {date.day} {date.hour} {date.minute} {date.second}
  • {date.weekday}: day of the week for the current date from 0 (Sunday) to 6 (Saturday)
• The request object:
  • {request.*}: property of the request object (Mage_Shipping_Model_Rate_Request) given by Magento (ex: {request.package_qty}). Use "Debug" option to get more details on available properties.

Functions

Numerical functions

• abs(x): absolute value
• ceil(x): round up
• exp(x): exponent
• floor(x): round down
• log(x): logarithm
• log(x, base): natural logarithm
• max(x, y, …): maximum, null values ignored
• min(x, y, …): minimum, null values ignored
• pi(): PI number
• pow(x, puissance): pow
• rand(min, max): random integer
• round(x)
• sqrt(x): square root

Functions to manipulate strings

• substr(string, start, length): returns a string segment.

Functions to manipulate arrays

• in_array(value, array(value1, value2, …)): returns true if the value is found in the array.
• array_match_any(array(value1, value2, …), array(value1, value2, …)): returns true if at least one value is found in both arrays.
• array_match_all(array(value1, value2, …), array(value1, value2, …)): returns true if both arrays are identical.

More functions

• range(value, min, max, include_min, include_max): returns true if value is greater than min and lower than max. By default, include_min and include_max are equal to true.

Special functions

• {table … in …}: defining values based on thresholds (examples)
• {switch … in …}: defining an associative table (examples)

The first parameter … of table and switch functions is the reference value, it can be either a variable or a formula.

• {count items[ where …]}: counts eligible items (examples)
• {count distinct …[ where …]}: counts all different values of a property for eligible items (examples)
• {sum …[ where …]}: calculates the sum of the values of a property for eligible items (examples)
• {min …[ where …]}: returns the minimum value of a property for eligible items (examples)
• {max …[ where …]}: returns the maximum value of a property for eligible items (examples)

The first parameter … of count distinct, sum, min and max functions must be a property (ex: product.attribute.weight).

The condition where is optional. If specified, it will be in the form of a formula.

Using foreach loops

foreach loops can perform a calculation on groups of products rather than consider all the products in the cart.
The overall result of a foreach loop is the sum of the results of each pass through the loop.

Inside a foreach loop, you can use new variables.

Examples

Deprecated variables

The following variables must be replaced by their equivalent.

• {cart.coupon} {cart.coupon_code}
• {cart.quantity} {cart.qty}
• {cart.price_excluding_tax} {cart.price-tax+discount}
• {cart.price_including_tax} {cart.price+tax+discount}
• {cart.weight.for-charge} {cart.weight_for_charge}
• {cart.weight.unit} {cart.weight_unit}
• {customer.group.code} {customer_group.code}
• {customer.group.id} {customer_group.id}
• {{customVar code=*}} {customvar.*}
• {destination.country.code} {shipto.country_id}
• {destination.country.name} {shipto.country_name}
• {destination.postcode} {shipto.postcode}
• {destination.region.code} {shipto.region_code}
• {free_shipping} {cart.free_shipping}
• {origin.country.code} {origin.country_id}
• {origin.country.name} {origin.country_name}
• {origin.region.code} {origin.region_id}
• {selection.quantity} {selection.qty}

• product.quantity item.qty
• product.price-tax+discount item.price-tax+discount
• product.price-tax-discount item.price-tax-discount
• product.price+tax+discount item.price+tax+discount
• product.price+tax-discount item.price+tax-discount
• product.option.* item.option.*
• product.option.* item.option.*

The tracking URL

The use of tracking_url property is reserved for experienced users. If you don't understand the instructions below, it is recommended that you avoid using this feature.

The tracking_url property overrides the field "Tracking URL" of an Advanced Shipping shipping mode. So you can specify a tracking URL foreach shipping method rather than one for all shipping mode.

To automatically insert the tracking number in the tracking URL, you must use {tracking_number}.

Magento does not support tracking links but tracking statuses. The extension Advanced Shipping provides an HTML link instead of the status, link allowing you to go on the carrier's website and follow the progress of the parcel.

When the tracking URL is built by the extension, the only information available is the tracking number and there was nowhere an access to the shipping method selected. In order to find the tracking URL in the configuration, you must specify the shipping method inside the tracking number, for example: colissimo:8Lxxxxxxxxxxx where colissimo is the code of the shipping method selected.
If no code is specified (if you enter only the tracking number), the URL used will be the one of the shipping mode.

To answer a recurrent question, Magento displays the tracking status from the back office or front office. If you want to insert the tracking URL in shipping mails, you need to develop yourself the retrieval of tracking URL and its incorporation in the mail, in fact, the Advanced Shipping extension simply provides customizable shipping methods without making big changes to Magento core to reduce incompatibility and update problems.

If you get a blank popup when you click on the tracking link, your problem is most likely related to the fact that you did not specify the code of the shipping method in the tracking number (see instructions above) and your global field "Tracking URL" is empty.

There are currently no plans to change this feature.