collection
A collection in a store.
To get the collection's metafields, use the get_metafields filter.
Properties
Indicates the total quantity of all products in the product collection. The total count includes items that have been filtered out by the current filter criteria.
To get the number of products displayed on the current page, namely the actual visible product count after filters are applied, use collection.products_count.
All of the tags applied to the products in the collection.
This includes tags for products that have been filtered out of the current view. A maximum of 1,000 tags can be returned.
To display the tags that are currently applied, use collection.tags.
All of the product types in a collection.
All of the product vendors in a collection.
The product type on a product type collection page.
You can query for products of a certain type at the /collections/types URL with a query parameter in the format of ?q=[type], where [type] is your desired product type.
The query value is case-insensitive, so shirts is equivalent to Shirts or SHIRTS.
The vendor name on a vendor collection page.
You can query for products from a certain vendor at the /collections/vendors URL with a query parameter in the format of ?q=[vendor], where [vendor] is your desired product vendor.
The query value is case-insensitive, so apparelco is equivalent to ApparelCo or APPARELCO.
The default sort order of the collection.
This is set on the collection's page in the SHOPLINE Admin.
The description of the collection.
The featured image for the collection.
The featured image for the collection is used by default. If the image isn't available, the system uses the featured image for the first product in the collection. If the first product in the collection doesn't have a featured image, null is returned.
The storefront filters that have been set up on the collection.
Only filters relevant to the current collection are returned. Filter data will not be returned for collections that contain over 5000 products.
The handle of the collection.
The ID of the collection.
The cover image for the collection.
This cover image is added on the collection's page in the SHOPLINE Admin.
The total number of products in the current view of the collection.
A timestamp for when the collection was published.
Use the date filter to format the timestamp.
The value of this field is the sorting order of the product collection specified by the URL parameter sort_by. It returns null if the parameter is not provided.
The available sorting options for the collection.
These are the active tags for the current product collection view, containing only the tags of products that have not been filtered out. If no tags are applied, or all tagged products in the current page have been filtered out, an empty array is returned.
The title of the collection.
The relative URL of the collection.
'%3e%3crect%20x='6'%20y='7.13049'%20width='13'%20height='10'%20rx='1'%20fill='black'/%3e%3cpath%20d='M12.4998%2012.936L-3.65042%200.604835L28.65%200.604838L12.4998%2012.936Z'%20stroke='white'%20stroke-linejoin='round'/%3e%3c/g%3e%3cdefs%3e%3cclipPath%20id='clip0_716_14611'%3e%3crect%20x='6'%20y='7.13049'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e)
'%3e%3crect%20x='5.63086'%20y='7.26086'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3cpath%20d='M12.1306%2013.0664L-4.01956%200.735206L28.2809%200.735209L12.1306%2013.0664Z'%20stroke='%231A2C42'%20stroke-linejoin='round'/%3e%3c/g%3e%3cdefs%3e%3cclipPath%20id='clip0_716_14599'%3e%3crect%20x='5.63086'%20y='7.26086'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e)