product - aareano/ifshop-wiki GitHub Wiki

This drop is corresponds to Shopify's.

additional properties

  • product.body_html
  • product.product_type
  • product.publish_on
  • product.published_at
  • product.published_scope
  • product.shop

missing properties

  • product.selected_variant
  • product.selected_or_first_available_variant
  • product.collections
  • product.compare_at_price_max
  • product.compare_at_price_min
  • product.compare_at_price_varies

altered properties

  • product.options

* indicates the field can be updated.

product.available

Returns true if a product is available for purchase. Returns false if all of the products variants' inventory_quantity values are zero or less, and their inventory_policy is not set to "Allow users to purchase this item, even if it is no longer in stock."

product.body_html

Returns the (HTML) description of the product.

Alias: product.content Alias: product.description

product.collections

Returns an array of all of the collections a product belongs to.

Input

This product belongs in the following collections:

{% for collection in product.collections %}
    {{ collection.title }}
{% endfor %}

Output

This product belongs in the following collections:

Sale
Shirts
Spring

product.published_at*

Returns the date of when this product was published.

Update Instructions:

Use the iso8601 filter. Keep in mind this date will be evaluated in the UTC time zone, so adjust the date object you pass into iso8601 as needed with the other date filters.

To unpublish the product, set this field to nil.

Input

{{ my_publishing_date | iso8601 }}

Output

2017-02-03T01:47:10-05:00

product.published_scope*

Returns the sales channels in which the product is visible (e.g. "global").

Update Instructions:

This is a simple text field.

There may be limits on the scopes available - this is being clarified up with Shopify staff.

product.first_available_variant

Returns the variant object of the first product variant that is available for purchase. In order for a variant to be available, its variant.inventory_quantity must be greater than zero or variant.inventory_policy must be set to continue. A variant with no inventory_policy is considered available.

product.handle*

Returns the handle of a product.

Update Instructions:

Remember a handle is lowercase with any spaces and special characters replaced by hyphens (-). Here are some details.

product.id

Returns the id of the product.

product.image

Returns the image associated with the product.

Alias: product.featured_image

product.images

Returns an array of the product's images.

product.options

Returns an array of the product's product_options.

Input

{% for option in product.options %}
    {{ option.name }}
{% endfor %}

Output

Color Size Material

Use size if you need to determine how many options a product has.

Input

{{ product.options.size }}

Output

3

product.price

Returns the price of the first variant. Use one of the money filters to return the value in a monetary format.

product.price_max

Returns the highest price of all the product's variants. Use one of the money filters to return the value in a monetary format.

product.price_min

Returns the lowest price of all the product's variants. Use one of the money filters to return the value in a monetary format.

product.price_varies

Returns true if the product's variants have varying prices. Returns false if all of the product's variants have the same price.

product.shop

Defined for the following events:

  • a product is created
  • a product is updated
  • a product is deleted

Returns the shop drop.

product.tags*

Returns an array of all of the product's tags. The tags are returned in alphabetical order.

Input

{% for tag in product.tags %}
    {{ tag }}
{% endfor %}

Output

new
leather
sale
special

Update Instructions:

If you try to update this field with custom liquid code, it is an easy field to update incorrectly, which can cause a lot of havoc in your store if you use tags regulaly. It is highly recommended that you use the "add tags" and "remove tags" options on the Modify a value action to update this field.

Make extra sure to have comma-with-space separated tags for the add/remove tag options:

Good: my, tags, are-awesome

Bad: my, ,, tags,are,awesome

product.template_suffix

Returns the name of the custom product template assigned to the product, without the product. prefix nor the .liquid suffix. Returns nil if a custom template is not assigned to the product.

Input

<!-- on product.wholesale.liquid -->
{{ product.template_suffix }}

Output

wholesale

product.title*

Returns the title of the product.

Update Instructions:

None. This is a simple text field.

product.product_type*

Returns the type of the product.

Alias: product.type

Update Instructions:

None. This is a simple text field.

product.publish_on*

This is a write-only (cannot be read) attribute of the product, it is only used for updates. product.publish_on is used to move the publishing date into the future.

If a product is already published, setting this value in the future will not unpublish it. The recommended method is to set the publish_on value, then unpublish the product, in that order.

Note that if the product is unpublished, setting the publish_on date for the current time or a time in the past will publish the product, but it will take some time (around a minute) for the effect to take. I don't know why this is - the vagaries of Shopify's API.

Update Instructions:

Use the iso8601 filter. Keep in mind this date will be evaluated in the UTC time zone, so adjust the date object you pass into iso8601 as needed with the other date filters.

To unpublish the product, set this field to nil.

Input

{{ my_publishing_date | iso8601 }}

Output

2017-02-03T01:47:10-05:00

***

#### `product.url`

Returns the relative URL of the product.

_Input_
```html
{{ product.url }}

Output

/products/awesome-shoes

product.variants

Returns an array the product's variants.

product.vendor*

Returns the vendor of the product.

Update Instructions:

None. This is a simple text field.