Addons by Reinos

Appearance

Order tag ​

The order tag is for getting a single order.

The tag ​

{exp:reinos_store:order}

Tag Parameters ​

Below are the Tag Parameters. Those parameters can be used in the tag described above

prefix ​

Prefix the variables, including the colon (the default is order:)

prefix="order:"

order_id ​

Set a order_id for the order you want to fetch. The tag needs order_id or hash, without them it shows its no results.

order_id=""

hash ​

Set a hash for the order you want to fetch

hash=""

member_id ​

Only show the order found by order_id or hash when it belongs to this member, e.g. member_id="{logged_in_member_id}". It doesn't select orders on its own, use the orders tag for all orders of a member.

member_id=""

status ​

Filter based on the status.

Possible options: open pending complete failed expired cancelled refunded paid_chargeback. Separate more statuses with a |.

status="open"
status="complete|refunded"

Tag Variable ​

Below are the Tag Variables. Those Variables can be used in the tag described above

no_results ​

Check if there is any result

{if no_results}...{/if}

order:can_complete ​

Check if the order can still be paid.

Some providers support to pay after the order has been created but somehow is now paid and still open

{if order:can_complete }
	Your order is not yet payed, finish your order by clicking <a href="{order:payment_url}">here</a>.
{/if}

order:payment_url ​

The payment url, used when the order is open and should be paid

{if order:can_complete }
	Your order is not yet payed, finish your order by clicking <a href="{order:payment_url}">here</a>.
{/if}

order:order_id ​

{order:order_id}

order:sync_order_entry_id ​

This is the entry that is synced to this order

{order:sync_order_entry_id}

order:time ​

{order:time format="%d %M %Y"}

order:transaction_id ​

{order:transaction_id}

order:status ​

The status: open, pending, complete, cancelled, refunded, failed, expired or paid_chargeback. Use this one in a conditional, it doesn't change with the language. To show the status, use order:status_label. Before v4.0.0 this was the label of the status.

{if order:status == 'complete'}
    ...
{/if}

order:status_label ​

The label of the status, translated: Open, Pending, Complete, Cancelled, Refunded, Failed, Expired or Paid (chargeback).

Available from v4.0.0

{order:status_label}

order:customer_company ​

{order:customer_company}

order:customer_first_name ​

{order:customer_first_name}

order:customer_last_name ​

{order:customer_last_name}

order:customer_email ​

{order:customer_email}

order:customer_phone ​

{order:customer_phone}

order:billing_address ​

{order:billing_address}

order:billing_address2 ​

{order:billing_address2}

order:billing_zip ​

{order:billing_zip}

order:billing_city ​

{order:billing_city}

order:billing_country ​

The ISO-2 lang code.

{order:billing_country}

order:billing_country_full_name ​

The full country name

{order:billing_country_full_name}

order:billing_state ​

The ISO-2 state code.

{order:billing_state}

order:billing_state_full_name ​

The full state name

{order:billing_state_full_name}

order:shipping_address ​

{order:shipping_address}

order:shipping_address2 ​

{order:shipping_address2}

order:shipping_zip ​

{order:shipping_zip}

order:shipping_city ​

{order:shipping_city}

order:shipping_country ​

The ISO-2 lang code.

{order:shipping_country}

order:shipping_country_full_name ​

The full country name

{order:shipping_country_full_name}

order:shipping_state ​

The ISO-2 state code.

{order:shipping_state}

order:shipping_state_full_name ​

The full state name

{order:shipping_state_full_name}

order:items ​

Loop over the items in the order

{order:items}
    {order:items:name}
    {order:items:price}
    {order:items:price:formatted}
    {order:items:old_price} // when dealing with a sale price, this is the original_price
    {order:items:old_price:formatted} // when dealing with a sale price, this is the original_price
    {order:items:tax}
    {order:items:tax:formatted}
    {order:items:tax_rate}
    {order:items:price_plus_tax}
    {order:items:price_plus_tax:formatted}
    {order:items:old_price_plus_tax} // when dealing with a sale price, this is the original_price
    {order:items:old_price_plus_tax:formatted} // when dealing with a sale price, this is the original_price
    {order:items:qty}
    {order:items:sku}
    {order:items:entry_id} // the entry that is connected to this item
    {order:items:disable_shipping}
    {order:items:price_total}
    {order:items:price_total:formatted}
    {order:items:old_price_total} // when dealing with a sale price, this is the original_price
    {order:items:old_price_total:formatted} // when dealing with a sale price, this is the original_price
    {order:items:price_total_plus_tax}
    {order:items:price_total_plus_tax:formatted}
    {order:items:old_price_total_plus_tax} // when dealing with a sale price, this is the original_price
    {order:items:old_price_total_plus_tax:formatted} // when dealing with a sale price, this is the original_price
    {order:items:custom_fields}
        {order:items:custom_fields:name}
        {order:items:custom_fields:label}
        {order:items:custom_fields:value}
        {order:items:custom_fields:is_modifier}
        {order:items:custom_fields:modifier:price}
        {order:items:custom_fields:modifier:price:formatted}
        {order:items:custom_fields:modifier:price_plus_tax}
        {order:items:custom_fields:modifier:price_plus_tax:formatted}
    {/order:items:custom_fields}
    {order:items:on_sale} // bool if the product is on sale
    {order:items:sync_order_items_entry_id} // this is the entry item that is synced to this order item
    {order:items:note}
    {order:items:weight} // the weight of one product, in the Weight unit of the Store settings
    {order:items:order_item_id} // the id of the ordered item, e.g. for the reorder tag (from v4.0.0)
    {order:items:parent_order_item_id} // the ordered item this item reorders or renews
    {order:items:parent_order_id} // the order of that item, 0 when there is none (from v4.0.0)
    {order:items:is_reorder} // bool if this item reorders or renews an earlier order, false when that order was deleted (from v4.0.0)
    {order:items:reorder_order_id} // the latest order that reordered or renewed this item, 0 when there is none (from v4.0.0)
{/order:items}

Show that a product renews an earlier order:

{order:items}
    {order:items:name}
    {if order:items:is_reorder}
        Renewal of order #{order:items:parent_order_id}
    {/if}
{/order:items}

order:subtotal_before_discount ​

{order:subtotal_before_discount}
{order:subtotal_before_discount:formatted}

order:subtotal_before_discount_plus_tax ​

{order:subtotal_before_discount_plus_tax}
{order:subtotal_before_discount_plus_tax:formatted}

order:subtotal ​

{order:subtotal}
{order:subtotal:formatted}

order:subtotal_plus_tax ​

{order:subtotal_plus_tax}
{order:subtotal_plus_tax:formatted}

order:discount ​

The discount is without tax: it is applied before the tax is calculated.

{order:discount}
{order:discount:formatted}

order:discount_plus_tax ​

Available from v4.0.0

The discount including the tax it takes off. Use this one next to {order:subtotal_before_discount_plus_tax} and {order:total_plus_tax}, so the amounts add up.

{order:discount_plus_tax}
{order:discount_plus_tax:formatted}

order:total ​

{order:total}
{order:total:formatted}

order:total_plus_tax ​

{order:total_plus_tax}
{order:total_plus_tax:formatted}

order:tax ​

{order:tax}
{order:tax:formatted}

order:shipping ​

{order:shipping}
{order:shipping:formatted}

order:shipping_plus_tax ​

{order:shipping_plus_tax}
{order:shipping_plus_tax:formatted}

order:has_free_shipping ​

Indicate if the order has free shipping by any discount/free shipping rule

{order:has_free_shipping}

order:entry_ids ​

Hold all entry_ids as a pipeline delimited string

{order:entry_ids}

order:custom_fields ​

Get the custom fields that are used in the checkout tag

{order:custom_fields}
    {order:custom_field:name}: {order:custom_field:value}
{/order:custom_fields}

order:is_paid ​

Show if the order is paid or not

{order:is_paid}

order:is_reverse_charge_eu ​

This flag indicate if we deal with a customer that has no TAX calculated

Note: this is only filled when Store Tax is installed.

{order:is_reverse_charge_eu}

order:member_id ​

The member_id of the member that is attached to this order.

{order:member_id}

order:tax_details ​

The Tax Details tag pair can give you a summary of the TAX. It holds multiple entries when you have multiple tax rates applied to the Order.

Available from v3.6.0

{order:tax_details}
    {order:tax_details:info} // if you have installed the Tax Module, the info field of the applied rule is shown here
    {order:tax_details:rate}
    {order:tax_details:amount}
    {order:tax_details:amount:formatted}
    {order:tax_details:count} // current count of the item
    {order:tax_details:total_results} // total count of the items
{/order:tax_details}

order:shipping_method ​

The shipping method of the order as the customer sees it: the Shipping Label setting for the shipping of the Store itself, or the label of the method of an add-on, e.g. the pickup location of Store Pickup. Empty when the order has no shipping method (e.g. with Ship orders off).

Available from v3.7.0

{order:shipping_method}

order:shipping_status ​

Return the status of the shipment, e.g. Not shipped or Shipped. It is always filled; it is set in the CP (with Manage Shipping Status) or by Store MyParcel and Store Pickup for their orders.

Available from v3.7.0

{order:shipping_status}

order:is_pickup ​

Check if the shipping method is a pickup method.

Available from v3.7.2

{order:is_pickup}

order:is_picked_up ​

Check if the order has been picked up.

Available from v3.9.0

{order:is_picked_up}

order:is_shipped ​

Check if the order has been shipped: the shipping status is shipped or parcel shipped, or an add-on such as Store MyParcel or Store Pickup says so for its own shipping statuses (see the reinos_store_is_shipped hook).

Available from v4.0.0

{if order:is_shipped}Your order is on its way{/if}

Other order variables ​

{order:hash} // the hash of the order, e.g. for links to the order page and downloads
{order:currency}
{order:customer_tax_no}
{order:return_url} // the url the customer returns to after the payment
{order:checkout_url} // the url of the checkout the order was placed from

order:gateway ​

Return the gateway name that is used for this order. e.g. mollie manual or stripe.

Available from v3.0.0

{order:gateway}

order:gateway_label ​

Return the label of the gateway that is used for this order, as set in the gateway settings in the CP. e.g. Mollie or Stripe (on-site, card). Without a label it is the default label of the gateway (e.g. Stripe (on-site, card)), or the gateway name made readable (e.g. Stripe elements for stripe_elements) when the gateway no longer exists. Use {order:gateway} for conditionals.

Available from v3.12.0

{order:gateway_label}

order:awaiting_confirmation ​

Check if the order is awaiting confirmation. This is only used when the payment gateway requires a confirmation step. For example when using the PayPal gateway. A payment that was confirmed and is still being processed by PayPal (e.g. an eCheck) is not awaiting confirmation anymore, the order can't be cancelled then.

Available from v3.11.0

{order:awaiting_confirmation}

order:cancel_payment_url ​

Get the URL to cancel the payment for an order that is awaiting confirmation. This is only used when the payment gateway requires a confirmation step. For example when using the PayPal gateway.

Available from v3.11.0

{order:cancel_payment_url}

order:confirm_payment_url ​

Get the URL to confirm the payment for an order that is awaiting confirmation. This is only used when the payment gateway requires a confirmation step. For example when using the PayPal gateway.

Available from v3.11.0

{order:confirm_payment_url}