Skip to content

Order tag

The orders tag getting a list of orders.

The tag

{exp:reinos_store:orders}

Pagination is following the ExpressionEngine standard. See https://docs.expressionengine.com/latest/templates/pagination.html#pagination for the implementation guide.

Tag Parameters

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

prefix

Prefix the variables

prefix="order:"

order_id

Set a order_id for the order you want to fetch

order_id=""

hash

Set a hash for the order you want to fetch

hash=""

member_id

Select all orders for the given member_id

member_id=""

status

Filter based on the status.

Possible options: open paid pending failed expired cancelled refunded paid_chargeback

status="open"
status="open|closed"

limit

status="50"

sort

Possible options are desc asc

sort="desc"

order_by

Possible options are status order_id time

sort="order_by"

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 we still cancan pay the order.

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

{order:status}

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: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:parent_order_item_id}
{/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

{order:discount}
{order:discount: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 will only be updated if you have installed the TAX module. See (https://addons.reinos.nl/store-tax)[https://addons.reinos.nl/store-tax]

{order:is_reverse_charge_eu}

cart: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}

order:shipping_method

Return the method for shipping. Please note this is the value of the setting Shipping Label.

{order:shipping_method}

Available from v3.7.0

order:shipping_status

Return the status of the shipment. This is only used when the Shipping module is installed or when the setting Manage Shipping Status is enabled in the setting

Available from v3.7.0

{order:shipping_status}