Official documentation for the Magento extension Owebia Shipping version 2.4.7 - 20/03/2012

Summary

The english version of the documentation is not up to date. If you can read french, please use the french version.
I have not enough time to translate the documentation in english. If somebody wants to translate the documentation in english or in an other language, please contact owebia.

Introduction

If you have a question, use the following topic : http://www.magentocommerce.com/boards/viewthread/38223/

The configuration syntax is similar to JSON syntax.

Example :

The character `#` at the beginning of a line indicates a comment.
A configuration element begins with the character `{` and ends with `}`.
A configuration element contains several properties associated with values.
The properties are alphanumeric (a-z0-9_), the separator property/value is the character `:`, values are numeric, boolean or string delimited by quotation marks. At the end of a line, a comma is the separator between the various properties.

List of properties:

• label: name (label)
• description: description (only visible if template show it)
• code: shipping method's code (optional but if specified it must be unique)
• enabled: configuration bloc activated or not (ex: true or false)
• fees: shipping fees (ex: "15.00" or "{table {cart.weight} in 0.5:5.30, 1.0:6.50}" or "100 * {cart.weight}")
• conditions: activation conditions (ex: "{cart.weight}>=1.0" or "{cart.price_excluding_tax}<100.00" or "({cart.weight}<=1.0) and ({cart.weight}>3.0) and {free_shipping}" or "{count products where product.attribute.color=='Bleu'}>1 or {count products where product.option.size=='2m'}>2")
• destination: countries (possibly regions) authorized in destination (ex: "FR,DE,US" or "FR(2A,2B,25000)" or "FR-(2A,2B)" or "FR(01,02,39600),CH,DE")
• origin: countries (possibly regions) authorized in origin (ex: "FR,DE,US" or "FR(2A,2B,25000)" or "FR-(2A,2B)" or "FR(01,02,39600),CH,DE")
• customer_groups: customer groups authorized (ex: "NOT LOGGED IN,Retailer" or "0,3")

The label : `label`

This will be the name given to the shipping method.

Elements such as the weight of goods can be inserted in the label.
To do this, use the following variables:

• {destination.country.name}: destination country name
• {destination.country.code}: destination country code
• {destination.region.code}: destination region code
• {destination.postcode}: destination postcode
• {origin.country.name}: origin country name
• {origin.country.code}: origin country code
• {origin.region.code}: origin region code
• {origin.postcode}: origin postcode
• {cart.weight}: weight of goods
• {cart.weight.unit}: weight unit
• {cart.quantity}: products quantity
• {cart.price_including_tax}: price including tax
• {cart.price_excluding_tax}: price excluding tax
• {store.code}: store code
• {store.name}: store name
• {store.address}: store address
• {store.phone}: store phone
• {date.timestamp}: UNIX timestamp of current date
• {date.year}: year of current date
• {date.month}: month of current date
• {date.day}: day of current date
• {date.hour}: hour of current date
• {date.minute}: minute of current date
• {date.second}: second of current date

This line will display for example "Colissimo (3.0kg / France)".

Shipping fees : `fees`

The property `fees` is specified as a formula (see introduction to formulas).

Introduction to formulas

Properties `fees` and `conditions` are specified as formulas.

Mathematical signs available:

• operators: *, /, + et -
• modulo: %
• brackets: ( et )
• boolean operators &&, and, ||, or, ==, <, >, <=, >=
• binary operators & et |
• operators group C ? X : Y (ex: "{cart.price_exluding_tax}>100 ? 15*{cart.weight} : 20*{cart.weight}")

Functions available:

• rounds: round(x), floor(x), ceil(x)
• absolute value: abs(x)
• maximum: max(x,y)
• minimum: min(x,y)
• random integer: rand(min,max)
• power: pow(x,puissance)
• PI number: pi()
• square root: sqrt(x)
• logarithm: log(x) for the natural logarithm or log(x,base)
• exponential: exp(x)

Ability to use advanced features like: casting to integer (int) casting to floating number (float), comparison with null or boolean values true and false.

Variables available:

• {cart.weight}: full package weight
• {cart.price_including_tax}: price including tax
• {cart.price_excluding_tax}: price excluding tax
• {cart.quantity}: items count in cart
• {date.timestamp}: UNIX timestamp of current date
• {date.year}: year of current date
• {date.month}: month of current date
• {date.day}: day of current date
• {date.hour}: hour of current date
• {date.minute}: minute of current date
• {date.second}: second of current date
• {free_shipping}: free shipping (offered by a Magento rule) [true/false]

You can put spaces and line returns in formulas (to air).

You can also use advanced features such as rates tables, copy of a property of another method, special functions, usage of product's attributes and options or usage of custom variables.

Usage of rates tables

In a table, you can include or exclude a limit value with characters '[' and ']' :

In a table, you must specify the reference value. For this, we can use one of the available variables.
You can also use a formula to define another reference variable.

Make a copy of a property of another method

It is possible to make a copy of a property in another using the syntax below.

You can use this technique in the properties 'conditions', 'fees', 'enabled', 'label', 'description', 'destination', 'origin', 'customer_groups' and 'tracking_url' but not in property 'code'.

Special functions in formulas

You can use special functions in formulas.

List of special functions :

• min(x,y) : calculate the minimum of several values (possibly more than two values). If one value is null, it is ignored.
• max(x,y) : calculate the maximum of several values (possibly more than two values). If one value is null, it is ignored.

Usage of product's attributes or options

It is possible to use product's attributes or options with the syntax below.

You can use this technique in the properties 'conditions' and 'fees'.

Available prefixes list:

• count: count (always followed by 'products')
• count distinct: distinct count (always followed by a property)
• sum: sum (always followed by a property)

Available properties list:

• product.attribute.* : attribute
  Interesting attributes:
  • sku : the sku
  • name : the name
  • weight : the weight
  • price : the price (as filled in product's card)
  • special_price : the special price (as filled in product's card)
• product.option.* : option
• product.stock.is_in_stock : product availability
• product.stock.quantity : stock quantity of the product

It's possible to specify conditions that must be met by products to be taken into account. To do this, simply add where followed by a formula.

If the property type is Yes/No, you should use true/false or 1/0 without quotes.

If the property type is Drop-down and you want to make a comparison with the id rather than with the value, you must use the following syntax:

Usage of foreach loops

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

Inside a foreach loop, it is possible to use new variables:

• {selection.weight}: selection weight
• {selection.quantity}: items count in the selection

When the selection is done on the sku, each selection is composed of a single article. We can use other variables:

• {product.weight}: weight of selected product
• {product.quantity}: quantity of selected product
• {product.attribute.*}: attribute of the selected product
• {product.option.*}: option of the selected product

Usage of Magento's Custom Variables

Since version 1.4.0.1 of Magento, it is possible to define custom variables.

Version 2.2.7 of Owebia Shipping allows you to use these custom variables using the following syntax:

The conditions : `conditions`

The property `conditions` is specified as a formula (see introduction to formulas) that must return a boolean value (true or false).

The destination : `destination`

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

The activation : `enabled`

Enable or disable the shipping method.

The value must be boolean.

The code : `code`

This is the identifier of the shipping method.

It must be unique. If not unique, it will be changed.

The description : `description`

This will be the description given to the shipping method.

The usage is the same as the property label.

The origin : `origin`

Same than destination but to filter shipping origin.
The syntax is the same as for destination filtering.

Customer groups : `customer_groups`

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

Tracking URL : `tracking_url`

Documentation is coming.

Comments

You can add a comment on the shipping method. It will not be shown anywhere but you can put annotations.

Changelog (in french)