shipping_methods

Returns the available shipping methods (options) for an order

Note: The term Shipping Method has been replaced with Shipping Option in the control panel though the function is still called shipping_methods.

Example

Uses of shipping_methods function appear in Skeletal in the cart section (both in cart/includes/shipping_options.template.html and cart/shopping_cart.template.html), as well as in product page in products/includes/buying_options.template.html for the shipping calculator.

The following example is used on the shopping cart page to generate a form input that will allow the customer to select the shipping option they want to use with regards to their order:

[%shipping_methods country:'[@ship_country@]' zip:'[@ship_zip@]'%]
    [%param header%]
    <form method="post" name="SHsummary" action="[%url page:'checkout'/%]">
    [%/param%]
    [%param *body%]
        <div class="form-group">
        <label class="d-block" for="[@id@]">
            <input class="float-left" type="radio" onclick="document.SHsummary.submit()" name="ship" value="[@id@]" id="[@id@]" [%if [@id@] == [@shipping_method_id@]%]checked[%/if%]>
            <h4> [@shipping_method@] - [%if [@shipping_quote@]%] P.O.A [%else%] [%if [@cost@] == 0%] [%if [@na@] == 0%] [%if [@config:free_shipping_label_for_webstore@]%] [@config:free_shipping_label_for_webstore@] [%else%] Free [%/if%] [%else%] Not Applicable [%/if%] [%else%] [%format type:'currency'%][@cost@][%/format%] [%/if%] [%/if%] </h4>
            [%if [@delivery_time@] >= 1%]
            <p>Estimated arrival of [%format type:'number' tl_unit:'day' tl_plural:'days'%][@delivery_time@][%/format%]</p>
            [%/if%]
            <p>[@shipping_description@]<p>
            </label>
        </div>
    [%/param%]
    [%param footer%]
    </form></td>
        </tr>
        <tr>
            <td>Shipping Cost To Post Code [@ship_zip@]</td>
            <td class="text-right">[%format type:'currency'%][@shipping_total@][%/format%]</td>
        </tr>
    [%/param%]
    [%param *ifempty%]
        [%if [@ship_zip@]%]
            <b class="text-danger">Shipping not available to [@ship_zip@] [@ship_country@], please try another location.</b>
        [%else%]
            Enter post code to calculate shipping
        [%/if%]
    </td>
    </tr>
    [%/param%]
[%/shipping_methods%]

This is the shipping_methods function on the buying_options template:

[%shipping_methods sortby:'delivery_time' sku:'[@sku@]' qty:'[@qty@]' zip:'[@ship_zip@]' country:'[@ship_country@]'%]
    [%param *header%]
        <br />
        <div role="alert" aria-atomic="true" aria-label="Shipping results">
    [%/param%]
    [%param *body%]
        <div role="group" aria-label="Shipping method option">
        <hr aria-hidden="true"/>
        <strong>[@shipping_method@]</strong> - [%if [@cost@] == 0%] [%if [@na@] == 0%] [%if [@config:free_shipping_label_for_webstore@]%] [@config:free_shipping_label_for_webstore@] [%else%] Free [%/if%] [%else%] Not Applicable [%/if%] [%else%] [%format type:'currency'%][@cost@][%/format%] [%/if%] [%IF [@delivery_time@]%](ETA: [@delivery_time@] days)[%/ IF%]<br />
        <i class="text-muted">[@shipping_description@]</i>
        </div>
    [%/param%]
    [%param *footer%]
        </div>
    [%/param%]
    [%param *ifempty%]
        [%if [@ship_zip@]%]<br /><p class="alert alert-danger alert-shipping-error" aria-label="alert" role="alert" aria-atomic="true">Shipping not available to [@ship_zip@] [@ship_country@], please try another location.</p>[%/if%]
    [%/ param%]
[%/shipping_methods%]

Usage

The shipping_methods function can be used in a few different ways. As per the two examples above, it can be used to select the preferred shipping option for an order on the cart/checkout pages, or as a shipping calculator for an individual item on their product page.

Parameters

Data Tags (body)