thumb_list

thumb_list

Generate a list of content based on the type specified

Example

[%thumb_list type:'products' template:'' filter_category:'' limit:'10'%]
    [%param *header%]
        All Products
    [%/param%]
    [%param *footer%]
    [%/param%]
    [%param *ifempty%]
        No Results Found
    [%/param%]
[%/thumb_list%]

Usage

A thumb_list tag is a versatile tag that will generate a list of content based on the parameters specified, from products to content. The wide variety of results and options are dictated by the parameters selected for the tag, see below for more samples of common thumb_list configurations or inspect the full list further down.

Splitting out parameters

What do you do if you want to do something fancy like use logic to determine a body template or a custom config to filter SKUs? Split out your parameter! This can be done on most Neto tags and is something we already do for params like *header & *footer.

To do this, simply take the param you want to split out from the tag and format like in this example where we perform so logic to determine our if statement:

[%thumb_list type:'products' filter_category:'' limit:'10'%]
    [%param template%]
        [%if [@name@] eq 'Shirts'%]
            shirt_template
        [%else%]
            default
        [%/if%]
    [%/param%]
...

Template parameter

If you use the *body parameter to define what each product or page does in your list you won't need to use this, however best use is relying on a template file here so you can easily modify things like product and content site-wide.

There are two types of templates this loads based on content type. If the thumb_list calls product data via something like products, it will load the template.html default located via Skeletal/thumbs/product/template.html. Everything else is considered a content type, so will load Skeletal/thumbs/content/template.html.

If you want to use a custom template, you'll need to first name your template using our traditional convention, mycustomthumb.template.html then call it using just the name of your template in the template param, template:'mycustomthumb'.

Types & Content Types

What's the difference? Types specify an overall table in neto, such as products, orders or content. Content types specify the individual content type under the content specific. So just like our blog example, first you need to select the type:'content' then specifically the blogs, content_type:'blog' based on the ID.

Pagination

The pagination tag will automatically set a number of pages based on the total results of the thumb list divided by the limit parameter. The paging tag needs to either be placed in the *header or *footer parameters.

<ul>
    [%paging limit:'3'%]
        [%param *previous_page%]
            <li><a href="[@URL@]">Previous Page</a></li>
        [%/param%]
        [%param *goback_pages%]
            <li><a href="[@URL@]">[@page@]</a></li>
        [%/param%]
        [%param *current_page%]
            <li class="active"><a href="[@URL@]">[@page@]</a></li>
        [%/param%]
        [%param *gonext_pages%]
            <li><a href="[@URL@]">[@page@]</a></li>
        [%/param%]
        [%param *next_page%]
            <li><a href="[@URL@]">Next Page</a></li>
        [%/param%]
    [%/paging%]
</ul>

Frequent issues

Your list not displaying the results you anticipated? Here's a few little things you can double check:

  • For some thumb_list types, having a limit is mandatory. Ensure there is a limit param.
  • Even if you are printing a thumb_list that isn't for a specific content type or category, you may still need to include an empty version of this parameter such as limit_category:'' or content_type:''.
  • Does the list you are requesting have content that's valid to show? You can always use the *ifempty param to print content is your list doesn't return results.

Common use scenarios

Order thumb list

The order thumb_list will list orders, but only in the context of a specific user session. So the user must be logged in before an order thumb list can be generated and is then generated based on specifically that user.

[%thumb_list type:'orders' limit:'10' /%]

Content thumb list

The content thumb_list typically needs a few specifications such as the type and content_type tags. This is commonly used for things like blog, article & basic content indexes and lists. The following will output all blog posts within the parent of Blog (default ID of 72).

[%thumb_list type:'content' content_type:'blog' filter_content:'' filter_category:'72' template:'' limit:'10' /%]

Remember that for content to be related, you need to link both pages together on the "related" section.

[%thumb_list type:'content' content_type:'' template:'' filter_category:'' filter_content:'[@content_id@]' limit:'10' /%]

Parameters

Name Options Description
`type:''` `adverts`, `allbrands`, `articles`, `blog_reviews`, `blogs`, `brands`, `buying_guides`, `categories`, `child_products`, `content_reviews`, `content`, `count_products`, `customers`, `dispute_messages`, `dispute_orders`, `dispute_reasons`, `disputes`, `dispute_types`, `favourites`, `free_gifts`, `item_kitting`, `item`, `item_variations`, `list_reminders`, `list_wishlists`, `new_arrivals`, `orders`, `order_statement`, `product_adverts`, `product_filters`, `product_history`, `product_reviews`, `products`, `quotes`, `random_products`, `referred_users`, `standing_orders`, `storder_products`, `storelocation`, `top_sellers`, `upsell_products`, `view_dispute`, `view_order`, `view_proposal`, `view_rma`, `view_service`, `view_standing_order` Defines the type of thumb_list that will be generated, refer to the table below for a description of what each type does. See underneath the parameter table for more information regarding each `type`.
`limit:''` Integer Used to determine the max number of results to show before paging takes effect
`template:''` Name of template (without the "template.html") Used to determine the HTML template to use from the related thumbnails folder (eg: thumbs/product/demo.template.html). If left blank, the default template (template.html) file is called
`global_counter:''` `0`/`1` Changes the count tag to run for all thumblists on the page with it set to `1`
`pgnum:''` Integer Load thumb_list on a specific page
`show_empty:''` `0`/`1` Print results that have no content
`content_type:''` Content type name Limits the thumblist to a specific content type
`filter_inventory_id:''` SKUs Comma separated list only for type "product" to identify specific SKUs to be loaded into thumb_list
`filter_a2z:''` Single letter Filters by the starting character specified in the parameter
`ignore_keywords:''` `0`/`1` Ignore any search query active on the page for the list
`filter_sku:''` String For the type products, specify SKU's the print in the thumblist separating with the `,` character
`filter_sku#:''` SKU Adds a filter to a specific sku with each tag used, so `filter_sku1:'PRODUCTSKU'` would limit list to load that specific sku, then `filter_sku2:'PRODUCTSKU2'` would add another and so on. This works the same as `filter_sku` but has no support for comma seperation.
`filter_exsku#:''` SKU This works the same as `filter_sku#` but excludes the SKU's included.
`group_id:''` String Specify a group for the thumblist. If not defined it will either use the current `group_id` or default `group_id`
`show_all:''` `0`/`1` For type products, if defined `filter_category` is ignored
`filter_category:''` String Specify a category for type products, if not defined it will use the current_category
`filter_content:''` String Specify a content page to filter, if not defined it will use the current page
`filter_category_type:''` String Specify a content type to generate a list from
`filter_rcontent:''` Content ID Comma separated filter by related content
`filter_variations:''` Variation ID Comma separated filter of variations
`filter_instock:''` `1`/`0` For type products, will show or hide products that are out of stock
`filter_wishlist:''` Wishlist ID Produces a list of products added to a wishlist based on ID
`filter_wishlistpurchased:''` `0`/`1` When true, it only shows purchased items in the wishlist. Requires a filter_wishlist param. When undefined, it shows both purchased and unpurchased. When false, shows only unpurchased items.
`filter_status:''` Number Only works with `type:'orders'`. Filters by the status of the order. Use the number corresponding to the status from this list:
Number Status
100 Quote
110 New
120 On Hold
130 New Backorder
135 Backorder Approved
140 Pick
150Pack
160Pending Dispatch
165Pending Pickup
170Dispatched
200Cancelled
210Uncommitted
`filter_inpromo:''` `0`/`1` Shows only products with a valid promotion price when true
`filter_warehouse:''` String Filter product list type by a specific warehouse ref
`filter_itemgroup:''` Product group ID Comma separated ID's for product groups
`ignore_session_filter:''` `0`/`1` Ignores the current sessions filter
`offset:''` Integer Offset the results by a determined number, can be used to split out content into unique sections
`show_child_products:''` `0`/`1` Works with type product, shows child products / variations in the list
`show_child_products_parent:''` `0`/`1` Hides parent products from result, only works with type favourites
`variation_specific:''` String Only works with the variations type, identifies a specific for the list
`filter_parent_content:''` `0`/`1` Works with content type, identifies a specific parent content to generate a list from
`ignorefilter:''` `0`/`1` When true on the type products it will print all results regardless of applied filters
`sortby:''` `name`, `SKU`, `brand`, `lowest_price`, `highest_price`, `largest_item`, `smallest_item`, `shortest_item`, `longest_item`, `sortorder`, `sortorder2`, `popular`, `top_sellers`, `new_arrivals`, `lowest_qty`, `highest_qty`, `random`, `trending`, `shippingweight`, `promo_end`, `sortbycol`, `wishlist`, `sortorder_price`, `sortorder2_price`, `sortorder_sortorder2`, `subtype_sortorder2`, `content_name`, `date_posted-desc`, `display_priority` The sort option for the list contents. Adding `-desc` will reverse order in most cases.

`display_priority` will sort by the priority value in the product category for each product.
`trending` & `popular` are the quantity sold over a 7 day period.
`top_sellers` is the quantity sold over the store life time.
`show_level:''` Integer - Value of level Shows the level specified
`show_next_level:''` Integer - Value of level Shows level after the selected level
`hide_no_shipping:''` `0`/`1` Enables shipping calculation but hides items that don't have shipping options. For `type:'products'` only
`cal_shipping:''` `0`/`1` Enables shipping calculation on each item. Can cause massive slow-downs, caching will not work. For `type:'products'` only
`show_rating:''` `0`/`1` Enabled the review/rating tag to be printed in the thumb_list body. For `type:'products'` only
`show_new_item:''` Integer Show `[@new_item@]` tag as true if items created within the days specified in the parameter. For `type:'products'` only
`filter_has_save:''` `0`/`1` Will show all products that have a price less than RRP or have a promo price set
`*header` HTML & b@se tags Renders a single usable space above the body
`*body` HTML & b@se tags Runs an array for each option in the tag
`*footer` HTML & b@se tags Renders a single usable space below the body
`ifempty:''` HTML & b@se tags If the thumb_list returns no results, it'll load this block instead

type:'' parameter options

Type Description
`adverts` Content based advertising campaigns
`allbrands` Deprecated - Alias for Brands
`articles` Deprecated - Article content type
`blog_reviews` Deprecated - Reviews for blogs
blogs Deprecated - Blog content type
brands Deprecated - Brands content type
`buying_guides` Deprecated - Buying guides content type
`categories` Default product category list
`child_products` Product list of child products based on parent SKU
`content_reviews` List of user reviews on specified content ID
`content` To be used with the `content_type` parameter to list content pages
`count_products` Lists total and quantity for product specified by SKU
`customer` Lists entire customer list, ideally used with the `filter_misc#` param
`dispute_messages` Contact messages between customer & site owner attached to a dispute
`dispute_orders` Orders engaged in an RMA dispute
`dispute_reasons` Reasons customers file a dispute on an order
`disputes` Current live disputes on a customer card
`dispute_types` Categories of order disputes
`favourites` Product "favourites" on a customer card, these are items that have been purchased on that account.
`free_gifts` Free products assigned to a SKU
`item_kitting` Returns a list of item information based on the `filter_SKU` param
item Prints information about one inventory item, given a `inventory_id` param
`item_variations` Variation product options based on SKU
`list_reminders` Provide a username and it will return reminders for checkout reminder system
`list_wishlists` User wishlists made against a customer card
new_arrivals Product list based on category filter and sorted by most recent additions
order Display a list of orders the customer has placed. The customer needs to be logged in
`order_statement` Statement of orders against a customer card & date range
`product_adverts` Product advertisements based on ad group
`product_filters` List of filters based on product specifics and values
`product_history` List of products viewed by the customer in a session
`product_reviews` Approved customer reviews on a SKU
products All inventory products, typically filtered to narrow results
`quotes` List of order quotes against a customer card
`random_products` List of random products taken from entire inventory, can be limited with filters
`referred_users` Returns customer cards with a forced filter on the `referall_username` param
`standing_orders` Standing orders against a customer card
`storder_products` Products within a standing order
`storelocation` Stores in the "Store finder" feature.
`top_sellers` Products from inventory sorted by the top selling
`upsell_products` Upsell products stored against a SKU
`view_dispute` Provide a `username` and a `dispute_id` and see the dispute
`view_order` Provide a `order_id` and a `username` and it will get the order information. (No Orderlines)
`view_proposal` Provide a `proposal_id` and a `username` and it will get the proposal information (no orderlines)
`view_rma` Provide a rma_id and a username and it will get the RMA information (no orderlines)
`view_service` Provide a `service_id` and a `username` and it will get the asset-service information (no orderlines)
`view_standing_order` Provide a `order_id` and a `username` and it will get the standing order information (no orderlines)
Name Example Description
`[@current_page@]` 1 Number of the current page of results
`[@limit@]` 10 Number of results per page. Set using the `limit:''` parameter
`[@total@]` 10
`[@total_pages@]` 13 Total number of pages based on the `limit:''` and number of results
`[@total_results@]` 121 Total number of results
`[@total_showing@]` 10 Number of results displayed

Data Tags (body)

Click on the type:'' below to display the returned fields.

Note: This is a work in progress. Not all types are currently documented.

Name Order Field Example Description
`[@article_id@]`, `[@blog_id@]`, `[@ccat_id@]`, `[@content_id@]`, `[@id@]`, `[@page_id@]` ID 72 Blog ID number
`[@blog_author@]`, `[@content_author@]`, `[@page_editor@]` Author Adam Smith Author's name
`[@blog_content@]`, `[@compatcat_description@]`, `[@content@]`, `[@content_description1@]`, `[@description@]`, `[@page_content@]` Description Welcome to my site. We have selected a large range of collectables ... Blog content
`[@blog_subheader@]`, `[@content_short_description2@]`, `[@short_description@]` Short Description 2 * Largest range of collectables in Australia Second short description. This field is hidden in the control panel
`[@blog_subject@]`, `[@category_name@]`, `[@compatcat_name@]`, `[@content_fullpath@]`, `[@content_name@]`, `[@name@]`, `[@page_header@]`, `[@title@]` Name My first blog Blog title
`[@category_ref@]`, `[@compatcat_ref@]`, `[@content_ref@]`, `[@page_index@]` Link ID First Can be used to reference the blog post instead of the `[@article_id@]`. Maximum 50 characters
`[@category_subheader@]`, `[@content_short_description1@]`, `[@page_subheader@]`, `[@subtitle@]` Short Description This is my first blog post on this site Short description of the blog content. Can be used on a blog list page. Maximum of 255 characters
`[@compat_id@]`, `[@compat_list_id@]`, `[@content_level@]`, `[@content_type_id@]` 3 ID number of the blog post category
`[@compatcat_description2@]`, `[@content_description2@]`, `[@description2@]` Description 2 * Checkout our specials page for the latest deals. Second description
`[@content_description3@]` Description 3 * Our business started in 1984 in Wooloongabba and has grown into ... Third description
`[@content_external_ref1@]`, `[@external_ref@]` External Ref 1 blue Used by 3rd party systems and for internal reference purposes. Maximum of 255 characters
`[@content_external_ref2@]` External Ref 2 /about-us Used by 3rd party systems and for internal reference purposes. Maximum of 255 characters
`[@content_external_ref3@]` External Ref 3 Limited Time Used by 3rd party systems and for internal reference purposes. Maximum of 255 characters
`[@content_external_src@]` External Src new Used by 3rd party systems and for internal reference purposes. Maximum of 50 characters
`[@content_label1@]` Label 1 * welcome Can be used to tag or label the blog post. Maximum of 50 characters
`[@content_label2@]` Label 2 * blog Can be used to tag or label the blog post. Maximum of 50 characters
`[@content_label3@]` Label 3 * intro Can be used to tag or label the blog post. Maximum of 50 characters
`[@content_short_description3@]` Short Description 3 * Check out our latest specisls Third short description. This field is hidden in the control panel
`[@count@]` 0 Counter for each returned blog post starting at `0`
`[@date_posted@]` Date Posted 2016-04-20 09:36:14 Date this content was posted (YYYY-MM-DD HH:MM:SS)
`[@date_updated@]` 2018-07-19 10:34:11 Last time the content was updated (YYYY-MM-DD HH:MM:SS)
`[@parent_ccat_id@]`, `[@parent_content_id@]`, `[@parent_id@]` Parent Content 1496 ID number of the parent content
`[@sortorder@]` Sort Order 10 Used to sort this brand in relation to other brands. Descending (highest first)
`[@templatebody@]` Body Template Template used to display the page. If blank, it is using the template selected in the blog setting - Settings & tools > All settings & tools > Control Panel > Content Types Manager > blog
`[@thumb@]` Main Image /assets/webshop/cms/85/72.jpg Path to the main image
`[@thumb_alt@]`, `[@thumb_alt1@]` Alt Image 1 /assets/webshop/cms/85/72-1.jpg Path to the alt 1 image
`[@timestamp@]` 2018-07-19 10:34:11 Date when the blog post was created (YYYY-MM-DD HH:MM:SS)
`[@url@]` URL http://www.mystore.com/blog/my-first-blog/ Web address of the blog post

* This field does not appear on the blog page in the control panel.

Name Order Field Example Description
`[@article_id@]`, `[@blog_id@]`, `[@ccat_id@]`, `[@content_id@]`, `[@id@]`, `[@page_id@]` ID 72 Brand ID number
`[@blog_author@]`, `[@content_author@]`, `[@page_editor@]` Author Adam Smith Author's name
`[@blog_content@]`, `[@compatcat_description@]`, `[@content@]`, `[@content_description1@]`, `[@description@]`, `[@page_content@]` Description Manufacturer of iPhones, iPads and Macintosh computers ... Brand description/td>
`[@blog_subheader@]`, `[@content_short_description2@]`, `[@short_description@]` Short Description 2 iPhone, Apple Watch, iPad, Macintosh, etc Second short description
`[@blog_subject@]`, `[@brand@]`, `[@category_name@]`, `[@compatcat_name@]`, `[@content_fullpath@]`, `[@content_name@]`, `[@name@]`, `[@page_header@]`, `[@title@]` Name Apple Brand name
`[@category_ref@]`, `[@compatcat_ref@]`, `[@content_ref@]`, `[@page_index@]` Link ID First Can be used to reference the blog post instead of the `[@article_id@]`. Maximum 50 characters
`[@category_subheader@]`, `[@content_short_description1@]`, `[@page_subheader@]`, `[@subtitle@]` Short Description Leading manufacturer of mobile devices and computers Short description of the content. Maximum of 255 characters
`[@compat_id@]`, `[@compat_list_id@]`, `[@content_type_id@]` 10 Brands content ID
`[@compatcat_description2@]`, `[@content_description2@]`, `[@description2@]` Description 2 New iPhones coming soon Second description
`[@content_description3@]` Description 3 Service and repairs Third description
`[@content_external_ref1@]`, `[@external_ref@]` External Ref 1 mobile phone Used by 3rd party systems and for internal reference purposes. Maximum of 255 characters
`[@content_external_ref2@]` External Ref 2 laptop Used by 3rd party systems and for internal reference purposes. Maximum of 255 characters
`[@content_external_ref3@]` External Ref 3 watch Used by 3rd party systems and for internal reference purposes. Maximum of 255 characters
`[@content_external_src@]`, `[@content_external_src@]` External Src new Used by 3rd party systems and for internal reference purposes. Maximum of 50 characters
`[@content_label1@]` Label 1 innovator Can be used to tag or label the brand. Maximum of 50 characters
`[@content_label2@]` Label 2 iPhone Can be used to tag or label the brand. Maximum of 50 characters
`[@content_label3@]` Label 3 Cupertino Can be used to tag or label the brand. Maximum of 50 characters
`[@content_level@]` 1 Level number. For example, if Filemaker brand is a child Apple, then Filemaker will be level 2
`[@content_short_description3@]` Short Description 3 Leading mobile phone manufacturer Third short description
`[@count@]` 0 Counter for each returned brand starting at `0`
`[@date_posted@]` Date Posted 2018-10-02 10:00:00 Date created (YYYY-MM-DD HH:MMSS)
`[@date_updated@]` 2018-10-02 20:05:26 Date last updated (YYYY-MM-DD HH:MMSS)
`[@parent_ccat_id@]`, `[@parent_content_id@]`, `[@parent_id@]` 0 ID number of the parent brand. Not normally used
`[@sortorder@]` Sort Order 0 The higher the sort order number, the higher it will appear in lists
`[@templatebody@]` Body Template Template used to display the page. If blank, it is using the template selected in the brand setting - **Settings & tools** > **All settings & tools** > **Control Panel** > **Content Types Manager** > **brand**
`[@thumb@]` Main Image /assets/webshop/cms/59/72.jpg Path to the main image
`[@thumb_alt@]`, `[@thumb_alt1@]` Alt Image 1 /assets/webshop/cms/59/72-1.jpg Path to the alt 1 image
`[@timestamp@]` 2018-07-19 10:34:11 Date when the brand was created (YYYY-MM-DD HH:MM:SS)
`[@url@]` URL http://www.mystore.com/brand/apple/ Web address of the brand page
Name Product Field Example Description
`[@acc_code@]`, `[@custom_label@]` Custom Label/Code 220/MDC Product identifier for eBay or accounting integration
`[@actual_height@]` Assembled Height 0.420 Assembled height in metres
`[@actual_length@]` Assembled Length 0.990 Assembled length in metres
`[@actual_width@]` Assembled Width 1.200 Assembled width in metres
`[@allow_oversell@]` Inventory Policy y **y** - Don't track inventory for this SKU, **n** - Track inventory for this SKU
`[@arrival_date@]` Date arrival 2018-12-31 Date at which the item is available. Displays date if in the future or nothing if the date is today or in the past (YYYY-MM-DD)
`[@artist_author@]` Author/Artists John Green Name of the author or artist
`[@availability_description@]` Availability Description New stock arriving in December Details of when the product will be available
`[@available_preorder_quantity@]` 79 The total of the **Qty on Hand** and **Preorder Qty** on the product page
`[@barcode@]` UPC/EAN 9300675031301 Product barcode
`[@base_unit@]` Base Unit of Measure kg The base unit of measure (ctn, ea, L, ml, cm, m, lb, g, kg)
`[@base_unit_qty@]` Base Unit Per Qty 2.0000 For display purposes only. Multiplies the actual qty by this qty. For example if base unit qty is 1.9 then a qty of 2 will display as 3.8
`[@brand@]` Brand Kingston Product brand
`[@committed_quantity@]` Total Qty Committed 5 Number of this product committed to orders
`[@count@]` 0 Counts for every time the body param is run as a whole number integer
`[@cubic@]` Cubic 0.010626 Shipping length x width x height in cubic metres
`[@date_created@]` Date Placed 2018-09-14 11:05:52 Date the product was created (YYYY-MM-DD HH:MM:SS)
`[@display_template@]` Website Design Template custom Name of the theme template assigned to the child product. Blank is default
`[@editable_bundle@]` Editable Kit n Is this product an editable kit. **n** - no, **y**- yes
`[@extra@]` Extra Options **Gift Message;*-TEXT_FIELD-;LENGTH=+80 Non-inventoried extras you offer the customer at the point of purchase. See [Product Import and Export Field Definitions](https://www.netohq.com/support/s/article/Product-Fields-2)
`[@format@]` Format Soft Cover The format of the product
`[@has_child@]` 0 Does this product have child items / variations. **0** no, **1** - yes
`[@has_components@]` 1 Editable kit with component products. **0** - no, **1** - yes
`[@has_from_price@]` 1 Is the price of this child product is used on the thumbnail. Normally the cheapest but can be changed to the dearest. **0** - no, **1** - yes
`[@has_mlp@]` 0 Does this product have Multi Level Pricing. **0** - no, **1** - yes
`[@height@]` Shipping Height 0.230 Shipping height in metres
`[@inpromo@]` 1 Is the product on promotion. **0** - no, **1** - yes
`[@instock@]` 1 Is the product in stock. **0** - no, **1** - yes
`[@inventory_id@]` 22343 Unique number for this product
`[@is_kit@]` 0 Is this a kitted product. **0** - no, **1** - yes
`[@itm_gp_id@]` 0 A unique id for kits/variations/parent items, typically for internal use
`[@itm_sortorder@]` Sort Order 1 1 Sort order (ascending order)
`[@itm_sortorder2@]` Sort Order 2 2 Sort order (ascending order)
`[@length@]` Shipping Length 0.220 Shipping length in metres
`[@limited_stock@]` 1 Displays true when the stock is lower then the global configuration for "low stock"
`[@manufacturer_model@]` Manufacturer model number A7DC/K The manufacturers model number of the product
`[@misc1@]`, `[@misc2@]`, etc *custom name* The Fault in Our Stars Custom product fields
`[@mlp_price@]` Multilevel Pricing 71.00 Cheapest multi level price unless regular price is cheaper
`[@model@]`, `[@name@]` Name Turtles All the Way Down Product name
`[@no_shipping@]` 0 When true there are no shipping options, requires `cal_shipping` param to be enabled
`[@notax@]` Tax Free Product n Tax Free Product. **n** - does attract tax, **y** - does not attract tax
`[@preorder@]` 1 Is the product on pre-order. **0** - no, **1** - yes
`[@preorder_date@]` Date arrival 2018-12-31 Returns date if in the future otherwise blank. Product field `Date arrival`
`[@preorder_quantity@]` Preorder Qty 80 Quantity of the product available to be purchased on pre-order
`[@price@]` Price 100.00 Product price based on the group the customer is assigned to. Does not take into account promo pricing
`[@product_subtype@]` Subtype Paperback The product subtype
`[@product_type@]` Type Book The product type
`[@promo_end@]` Promo End 2018-08-04 12:00:00 Promotion end date (YYYY-MM-DD HH:MM:SS)
`[@promo_price@]` Promo Price 90.00 Product promotional price based on the group the customer is assigned to
`[@promo_save@]` 10.00 Difference between the regular price and the promo price (percentage)
`[@promo_start@]` Promo Start 2018-08-04 12:00:00 Promotion start date (YYYY-MM-DD HH:MM:SS)
`[@reorder_quantity@]` Reorder Qty 30 The quantity to reorder from the supplier, used for accounting systems
`[@restock_warning_level@]` Restock Warning Level 10 If this feature is turned on, an email notification will be sent if the stock on hand gets below this number
`[@retail@]` RRP 125.00 Recommended retail price
`[@rndm@]` nqejK Generates a random number each time it is printed in an array
`[@save@]` 28.00 Percentage difference between the RRP and the selling price
`[@save_price@]` 35.00 Difference between the RRP and the selling price
`[@service_only@]` Service Item n Service product. Shipping methods and rates are ignored for service items
`[@sh_type_id@]` Shipping Category 1 ID number of the shipping category. Blank if **Service Item** is selected
`[@short_description@]` Short Description Turtles All the Way Down is a young adult novel written by American author John Green Short product description (up to 255 characters)
`[@single_price@]` 110.00 Price for one of this product
`[@sku@]` SKU 17MD-Black Product SKU
`[@start_date@]` Date arrival 2018-07-31 The date the next order from the supplier is due to arrive (YYYY-MM-DD)
`[@store_price@]` 110.00 Price for one of this product
`[@store_quantity@]` Qty On Hand 26 Available stock to sell. It is calculated by the total of all the warehouses minus the committed stock
`[@subtitle@]` Subtitle Fiction Normally appears below the name of the product on product pages
`[@tax_inc@]` Tax Inclusive y Price includes tax. **n** no, **y** - yes
`[@thumb@]` Main /assets/thumb/17MD-Black.jpg Main product image thumbnail. If the child product has no image the parent image is returned
`[@thumb_1@]`, `[@thumb_2@]`, etc Alt 1, Alt 2, etc /assets/alt_1_thumb/17MD-Black.jpg Alt product images thumbnails. Product fields Alt 1, Alt 2, etc
`[@unit@]` Selling Unit of Measure g The selling unit of measure. Can appear on invoices, etc
`[@url@]` Product URL http://www.mysite.com/turtles-all-the-way-down Product web address
`[@weight@]` Shipping Weight 0.1000 Shipping weight on kilograms
`[@width@]` Shipping Width 0.210 Shipping width in metres
Name Product Field Example Description
`[@acc_code@]` Custom Label/Code 220/MDC Product identifier for eBay or accounting integration
`[@actual_height@]` Assembled Height 0.420 Assembled height in metres
`[@actual_length@]` Assembled Length 0.990 Assembled length in metres
`[@actual_width@]` Assembled Width 1.200 Assembled width in metres
`[@allow_oversell@]` Inventory Policy y **y** - Don't track inventory for this SKU, **n** - Track inventory for this SKU
`[@arrival_date@]` Date arrival 2018-12-31 Date at which the item is available. Displays date if in the future or nothing if the date is today or in the past (YYYY-MM-DD)
`[@artisit_author@]` Author/Artists John Green Name of the author or artist
`[@availability_description@]` Availability Description New stock arriving in December Details of when the product will be available
`[@barcode@]` UPC/EAN 9300675031301 Product barcode
`[@base_unit@]` Base Unit of Measure kg The base unit of measure (ctn, ea, L, ml, cm, m, lb, g, kg)
`[@base_unit_qty@]` Base Unit Per Qty 2.0000 For display purposes only. Multiplies the actual qty by this qty. For example if base unit qty is 1.9 then a qty of 2 will display as 3.8
`[@brand@]` Brand Kingston Product brand
`[@count@]` 0 Counts for every time the body param is run as a whole number integer
`[@cubic@]` Cubic 0.010626 Shipping length x width x height in cubic metres
`[@date_created@]` Date Placed 2018-09-14 11:05:52 Date the product was created (YYYY-MM-DD HH:MM:SS)
`[@display_template@]` Website Design Template custom Name of the theme template assigned to the child product. Blank is default
`[@editable_bundle@]` Editable Kit n Is this product an editable kit. **n** - no, **y**- yes
`[@extra@]` Extra Options **Gift Message;*-TEXT_FIELD-;LENGTH=+80 Non-inventoried extras you offer the customer at the point of purchase. See [Product Import and Export Field Definitions](https://www.netohq.com/support/s/article/Product-Fields-2)
`[@format@]` Format Soft Cover The format of the product
`[@has_components@]` 1 Editable kit with component products. **0** - no, **1** - yes
`[@height@]` Shipping Height 0.230 Shipping height in metres
`[@inpromo@]` 1 Is the product on promotion. **0** - no, **1** - yes
`[@inventory_id@]` 22343 Unique number for this product
`[@is_kit@]` 0 Is this a kitted product. **0** - no, **1** - yes
`[@itm_gp_id@]` 0 A unique id for kits/variations/parent items, typically for internal use
`[@itm_sortorder@]` Sort Order 1 1 Sort order (ascending order)
`[@itm_sortorder2@]` Sort Order 2 2 Sort order (ascending order)
`[@length@]` Shipping Length 0.220 Shipping length in metres
`[@manufacturer_model@]` Manufacturer model number A7DC/K The manufacturers model number of the product
`[@misc1@]`, `[@misc2@]`, etc *custom name* The Fault in Our Stars Custom product fields
`[@model@]` Name Turtles All the Way Down Product name
`[@notax@]` Tax Free Product n Tax Free Product. **n** - does attract tax, **y** - does not attract tax
`[@preorder@]` 1 Is the product on pre-order. **0** - no, **1** - yes
`[@preorder_quantity@]` Preorder Qty 80 Quantity of the product available to be purchased on pre-order
`[@product_subtype@]` Subtype Paperback The product subtype
`[@product_type@]` Type Book The product type
`[@promo_price@]` Promo Price 90.00 Product promotional price based on the group the customer is assigned to
`[@retail@]` RRP 125.00 Recommended retail price
`[@service_only@]` Service Item n Service product. Shipping methods and rates are ignored for service items
`[@sh_type_id@]` Shipping Category 1 ID number of the shipping category. Blank if **Service Item** is selected
`[@short_description@]` Short Description Turtles All the Way Down is a young adult novel written by American author John Green Short product description (up to 255 characters)
`[@sku@]` SKU 17MD-Black Product SKU
`[@start_date@]` Date arrival 2018-07-31 The date the next order from the supplier is due to arrive (YYYY-MM-DD)
`[@store_price@]` 110.00 Price for one of this product
`[@store_quantity@]` Qty On Hand 26 Available stock to sell. It is calculated by the total of all the warehouses minus the committed stock
`[@subtitle@]` Subtitle Fiction Normally appears below the name of the product on product pages
`[@tax_inc@]` Tax Inclusive y Price includes tax. **n** no, **y** - yes
`[@unit@]` Selling Unit of Measure g The selling unit of measure. Can appear on invoices, etc
`[@weight@]` Shipping Weight 0.1000 Shipping weight on kilograms
`[@width@]` Shipping Width 0.210 Shipping width in metres
Name Order Field Example Description
`[@amount_owed@]` Amount Owed 290 Amount outstanding on the order
`[@amount_paid@]` 315.29 Amount already paid on the order
`[@bill_country_name@]` Country Australia Country name from the billing address
`[@bill_state_name@]` State Queensland State from the billing address
`[@count@]` 0 Counts for every time the body param is run as a whole number integer
`[@customer_po@]` Purchase Order # D47845413 Customer purchase order number
`[@customer_ref1@]`, `[@customer_ref2@]`, etc Custom Field 1 Wholesale Custom order fields. The field name is customisable
`[@date_closed@]` 2017-11-08 Date the order was completed/closed (YYYY-MM-DD)
`[@date_due@]` Payment date 2018-09-14 00:00:00 Payment due date (YYYY-MM-DD 00:00:00)
`[@date_due_text@]` Payment date 2018-09-14 Payment due date (YYYY-MM-DD)
`[@date_exported@]` 2018-09-15 11:39:42 Exported using an export template where **Record Each Export in Batch Export History Log** is set (YYYY-MM-DD HH:MM:SS)
`[@date_invoiced@]` Date Invoiced 2018-09-14 Date the order was invoiced to the customer (YYYY-MM-DD)
`[@date_placed@]` Date Placed 2018-09-14 11:05:52 Date the order was placed by the customer (YYYY-MM-DD HH:MM:SS)
`[@date_required@]` Date Required 2018-09-17 00:00:00 On some checkouts the customer can specify a date they'd like the order delivered, this is that date (YYYY-MM-DD 00:00:00)
`[@date_updated@]` Date Updated 2018-09-14 11:05:52 Date and time the order was last updated (YYYY-MM-DD HH:MM:SS)
`[@discount_code@]` Coupons and Discount Codes 10OFF Discount code applied to the order
`[@discount_total@]` Discount Subtotal 26.46 Total of the product and shipping discounts
`[@email@]` E-mail fred.smith@customer.com Customer's email address
`[@grand_total@]` Grand Total 218.50 Grand total of the order
`[@has_date_due@]` 1 Date due for the order (if applicable)
`[@has_product_discounts@]` 1 A product on the order has been discounted or a discount has been applied. **0** - no discount, **1** - discount applied
`[@order_id@]` Order ID N11398 Order number. Order field `Order ID`
`[@order_status@]`, `[@order_status_name@]` Status Pack Current status of the order
`[@sales_email@]` keith@mystore.com Email address of the Sales Person
`[@sales_first_name@]` Sales Person Keith First name of the Sales Person
`[@sales_last_name@]` Sales Person Anderson Last name of the Sales Person
`[@salesperson@]` keith Username of the Sales Person
`[@shipping_discount@]` Shipping Discount 5.23 Shipping discount
`[@tax_inc@]` Tax Inclusive y Tax is included in the product orderlines. **n** - no, **y** - yes
`[@terms@]` Terms Due On Invoice Payment terms

Was this article useful?

Be notified when this page is updated. Optional.