Order coupon Loop
Retrieve order coupons information for a given order
{loop type="order_coupon" name="the-loop-name" [argument="value"], [...]}Important informations :
* : argument is required
** : at least one of ** marked argument is required
Global arguments
| Argument | Description |
|---|---|
| backend_context |
Determine if loop is use in backend context. default : false example : backend_context="on" |
| force_return |
force return result for i18n tables even if there is no record default : false example : force_return="on" |
| limit |
The maximum number of results to display. example : limit="10" |
| name * |
The loop name. This name must be unique and is used to reference this loop further in the page (see ifloop, elseloop or pageloop) |
| offset |
The first product to display offset. Will not be used if `page` argument is set. default : 0 example : offset="1" |
| page |
The page to display. example : page="2" |
Loop arguments
| Argument | Description |
|---|---|
| order * |
A single order id. example : order="2" |
Global outputs
| Variable | Description |
|---|---|
| $LOOP_COUNT | the current results index, starting from 1 |
| $LOOP_TOTAL | the total number of results returned by the loop |
| $CREATE_DATE | The creation date of this Order_coupon |
| $UPDATE_DATE | The last modification date of this Order_coupon |
Loop outputs
| Variable | Description |
|---|---|
| $CODE | the coupon code |
| $DAY_LEFT_BEFORE_EXPIRATION | days left before coupon expiration |
| $DESCRIPTION | the coupon description |
| $EXPIRATION_DATE | the coupon expiration date |
| $FREE_SHIPPING_FOR_COUNTRIES_LIST | comma separated list of country IDs for which the free shipping applies |
| $FREE_SHIPPING_FOR_MODULES_LIST | comma separated list of shipping module IDs for which the free shipping applies |
| $ID | the coupon id |
| $IS_AVAILABLE_ON_SPECIAL_OFFERS | true if the coupon applies to discounted products |
| $IS_CUMULATIVE | true if the coupon is cumulative |
| $IS_REMOVING_POSTAGE | true if the coupon provides free shipping |
| $IS_USAGE_CANCELED | true if the usage of this coupon was canceled (probably when the related order was canceled), false otherwise |
| $SHORT_DESCRIPTION | the coupon short description |
| $TITLE | the coupon title |