Documentation / Theme editor / Foreach objects

All those objects comes from foreach loops. They represents an "iteration item".

General objects

These objects are not related to the store, they are platform-generic.

country

Fields

item["countryid"]
item["code"]
item["name"]

Field content

Unique ID of the countyr
3-letter universal ISO code
Country name

Named properties

Foreach collections

countries

state

Fields

item["stateid"]
item["countryid"]
item["code"]
item["name"]

Field content

Unique ID of the state
Unique ID of the parent country
2-letter state/province code
Country name

Named properties

Foreach collections

states

Content objects

These objects are related to the store (products, orders, etc.).

category

Fields

item["categoryid"]
item["createdon"]
item["name"]
item["imageurl"]
item["imagethumburl"]
item["products"]
item["seometakeywords"]
item["seopagedescription"]
item["seopagetitle"]
item["slug"]
item["status"]

Field content

Unique ID of the category
Creation date
Category name
Image url
Image thumbnail url
Number of products in category
SEO : Meta keywords
SEO : Meta description
SEO : Page title
URL shorthand
Status code

Named properties

Foreach collections

store.categories

collection

Fields

item["collectionid"]
item["createdon"]
item["name"]
item["imageurl"]
item["imagethumburl"]
item["products"]
item["seometakeywords"]
item["seopagedescription"]
item["seopagetitle"]
item["slug"]
item["status"]

Field content

Unique ID of the collection
Creation date
Collection name
Image url
Image thumbnail url
Number of products in collection
SEO : Meta keywords
SEO : Meta description
SEO : Page title
URL shorthand
Status code

Named properties

Foreach collections

store.collections

order

Fields

item["alltaxes"]
item["alltaxesformated"]
item["billingfirstname"]
item["billinglastname"]
item["billingfullname"]
item["billingemail"]
item["billingphone"]
item["billingcompany"]
item["billingaddressline1"]
item["billingaddressline2"]
item["billingcountryid"]
item["billingcountryname"]
item["billingstateid"]
item["billingstatename"]
item["billingcity"]
item["billingpostalcode"]
item["couponcode"]
item["coupondiscount"]
item["coupondiscountformated"]
item["createdon"]
item["customerid"]
item["customernotes"]
item["discount"]
item["items"]
item["number"]
item["orderid"]
item["shippingname"]
item["shippingoption"]
item["status"]
item["total"]
item["totalformated"]
item["totalprice"]
item["totalpriceformated"]
item["totaltaxes"]
item["totaltaxesformated"]
item["totalshipping"]
item["totalshippingformated"]
item["totalshippingtaxes"]
item["totalshippingtaxesformated"]
item["totaldiscount"]
item["totaldiscountformated"]
item["paymentmethodname"]
item["shippingfirstname"]
item["shippinglastname"]
item["shippingfullname"]
item["shippingemail"]
item["shippingphone"]
item["shippingcompany"]
item["shippingaddressline1"]
item["shippingaddressline2"]
item["shippingcountryid"]
item["shippingcountryname"]
item["shippingstateid"]
item["shippingstatename"]
item["shippingcity"]
item["shippingpostalcode"]

Field content

Total taxes in this order
Total taxes in this order (currency formated)
Billing: First name
Billing: Last name
Billing: First and last name
Billing: Email address
Billing: Phone number
Billing: Company name
Billing: Address line 1
Billing: Address line 2
Billing: Unique ID of the country
Billing: Country name
Billing: Unique ID of the state
Billing: State name
Billing: City
Billing: Zip/Postal Code
Coupon code
Calculated coupon discount
Calculated coupon discount (currency formated)
Date when order was placed
Unique ID of the customer
Notes entered by the customer at checkout
Additionnal discount (entered manually)
Number of items in the order
Order number
Unique ID of the order
Shipping method name
Shipping option code
Order status
Order total
Order total (currency formated)
Order subtotal
Order subtotal (currency formated)
Order taxes
Order taxes (currency formated)
Order shipping cost
Order shipping cost (currency formated)
Order shipping taxes
Order shipping taxes (currency formated)
Order total discount
Order total discount (currency formated)
Payment method name
Shipping: First name
Shipping: Last name
Shipping: First and last name
Shipping: Email address
Shipping: Phone number
Shipping: Company name
Shipping: Address line 1
Shipping: Address line 2
Shipping: Unique ID of the country
Shipping: Country name
Shipping: Unique ID of the state
Shipping: State name
Shipping: City
Shipping: Zip/Postal Code

Named properties

Foreach collections

customer.orders

pricerange

Fields

item["id"]
item["name"]

Field content

Unique ID of the price rang
Name (price, low to high)

Named properties

Foreach collections

store.products.priceranges

product

Fields

item["allowbuynostock"]
item["barcode"]
item["createdon"]
item["description"]
item["discountprice"]
item["discounted"]
item["firstimageid"]
item["minbuy"]
item["maxbuy"]
item["name"]
item["nbsold"]
item["price"]
item["productid"]
item["quantity"]
item["realprice"]
item["seometakeywords"]
item["seopagedescription"]
item["seopagetitle"]
item["sku"]
item["slug"]
item["status"]
item["taxable"]
item["type"]
item["vendor"]
item["weight"]

Field content

Determine if available if backorder
Barcode number
Product creation date
Description
Discount price
Discounted (true or false)
Unique ID of the first image
Min quantity to buy
Max quantity to buy
Name
Number of this product sold
Regular price
Unique ID of the product
Quantity in stock
Price (normal or discounted)
SEO : Meta keywords
SEO : Meta description
SEO : Page title
Unique SKU code
URL shorthand
Status code
Determines if taxable
Vendor (brand) name
Weight (in lb)

Named properties

tag

Fields

item["tag"]
item["quantity"]

Field content

Tag
Quantity of blog posts (blog.posts.tags only)

Named properties

Foreach collections

blog.posts.tags

vendor

Fields

item["name"]

Field content

Vendor name (brand name)

Named properties

Foreach collections

store.products.vendors

year

Fields

item["year"]
item["quantity"]

Field content

4-digits year
Quantity of blog posts (blog.posts.years only)

Named properties

Foreach collections

blog.posts.years