import { Objects } from '../..'; export const objects: Objects = { media: { summary: 'An abstract media object that can represent the following object types:\n\n- [`image`](/docs/api/liquid/objects/image)\n- [`model`](/docs/api/liquid/objects/model)\n- [`video`](/docs/api/liquid/objects/video)\n- [`external_video`](/docs/api/liquid/objects/external_video)', description: 'An abstract media object that can represent the following object types:\n\n- [`image`](https://shopify.dev/docs/api/liquid/objects/image)\n- [`model`](https://shopify.dev/docs/api/liquid/objects/model)\n- [`video`](https://shopify.dev/docs/api/liquid/objects/video)\n- [`external_video`](https://shopify.dev/docs/api/liquid/objects/external_video) The `media` object can be returned by the [`product.media` array](https://shopify.dev/docs/api/liquid/objects/product#product-media) or a\n[`file_reference` metafield](https://shopify.dev/apps/metafields/types).\n\nYou can use [media filters](https://shopify.dev/docs/api/liquid/filters/media-filters) to generate URLs and media displays. To learn about how\nto use media in your theme, refer to [Support product media](https://shopify.dev/themes/product-merchandising/media/support-media).\n\n\n\n**Note**\n\n> Each media type has unique properties in addition to the general `media` properties. To learn about these\n> additional properties, refer to the reference for each type.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/media)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { id: { type: 'number', description: 'The ID of the media. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/media/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, position: { type: 'number', description: 'The position of the media in the [`product.media` array](https://shopify.dev/docs/api/liquid/objects/product#product-media). If the source is a [`file_reference` metafield](https://shopify.dev/apps/metafields/types), then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/media/position)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, media_type: { type: 'string', description: "The media type. \n\n\n\n#### Filter for media of a specific type\n\nYou can use the `media_type` property with the [`where` filter](/docs/api/liquid/filters/where) to filter the [`product.media` array](/docs/api/liquid/objects/product#product-media) for all media of a desired type.\n\n\n```liquid\n\n{% assign images = product.media | where: 'media_type', 'image' %}\n\n{% for image in images %}\n {{- image | image_url: width: 300 | image_tag }}\n{% endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/media/media_type)\n\n\nLast Updated: 2nd February 2025\n\n\n", literal: [ 'image', 'model', 'video', 'external_video' ] }, preview_image: { type: 'object', description: "A preview image of the media. \n\n**Note**\n\n> Preview images don't have an ID attribute.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/media/preview_image)\n\n\nLast Updated: 2nd February 2025\n\n\n", scope: 'image' }, alt: { type: 'string', description: 'The alt text of the media. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/media/alt)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, address: { summary: 'An address, such as a customer address or order shipping address.', description: 'An address, such as a customer address or order shipping address. \n\n**Tip**\n\n> Use the [`format_address` filter](https://shopify.dev/docs/api/liquid/filters/format_address) to output an address according to its locale.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { company: { type: 'string', description: 'The company of the address. If no company is specified, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/company)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, phone: { type: 'string', description: 'The phone number of the address. If no phone number is specified, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/phone)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, first_name: { type: 'string', description: 'The first name of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/first_name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, last_name: { type: 'string', description: 'The last name of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/last_name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, name: { type: 'string', description: 'A combination of the first and last names of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, url: { type: 'string', description: 'The relative URL for the address. \n\n**Note**\n\n> This only applies to customer addresses.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/url)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, summary: { type: 'string', description: 'A summary of the address, including the following properties:\n\n- First and last name\n- First and second lines\n- City\n- Province\n- Country \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/summary)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, id: { type: 'number', description: 'The ID of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, address1: { type: 'string', description: 'The first line of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/address1)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, address2: { type: 'string', description: 'The second line of the address. If no second line is specified, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/address2)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, city: { type: 'string', description: 'The city of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/city)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, zip: { type: 'string', description: 'The zip or postal code of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/zip)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, country_code: { type: 'string', description: 'The country of the address in [ISO 3166-1 (alpha 2) format](https://www.iso.org/glossary-for-iso-3166.html). \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/country_code)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, province_code: { type: 'string', description: "The province of the address in [ISO 3166-2 (alpha 2) format](https://www.iso.org/glossary-for-iso-3166.html). \n\n**Note**\n\n> The value doesn't include the preceding [ISO 3166-1](https://www.iso.org/glossary-for-iso-3166.html) country code.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/province_code)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, country: { type: 'object', description: 'The country of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/country)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'country' }, street: { type: 'string', description: 'A combination of the first and second lines of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/street)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, province: { type: 'string', description: 'The province of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/address/province)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, collections: { summary: 'All of the [collections](/docs/api/liquid/objects/collection) on a store.', global: true, description: 'All of the [collections](https://shopify.dev/docs/api/liquid/objects/collection) on a store. \n\n\n\n#### Iterate over the collections\n\nYou can iterate over `collections` to build a collection list.\n\n\n```liquid\n\n{% for collection in collections %}\n {{- collection.title | link_to: collection.url }}\n{% endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collections)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'array', scope: 'collection' }, pages: { summary: 'All of the [pages](/docs/api/liquid/objects/page) on a store.', global: true, description: "All of the [pages](https://shopify.dev/docs/api/liquid/objects/page) on a store. \n\n\n\n#### Example\n\nYou can access a specific page through the `pages` object using the page's [handle](/docs/api/liquid/basics#handles).\n\n\n```liquid\n\n{{ pages.contact.title }}\n{{ pages['about-us'].title }}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/pages)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'array', scope: 'page' }, all_products: { summary: 'All of the products on a store.', global: true, description: "All of the products on a store. \n\n**Note**\n\n> The `all_products` object has a limit of 20 unique handles per page. If you want more than 20 products,\nthen consider using a collection instead.\n\n#### Example\n\nYou can use `all_products` to access a product by its [handle](/docs/api/liquid/basics#handles). This returns the [`product`](/docs/api/liquid/objects/product) object for the specified product. If the product isn't found, then `empty` is returned.\n\n```liquid\n\n{{ all_products['love-potion'].title }}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/all_products)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'array', scope: 'product' }, app: { summary: 'An app. This object is usually used to access app-specific information for use with [theme app extensions](/apps/online-store/theme-app-extensions).', description: 'An app. This object is usually used to access app-specific information for use with [theme app extensions](https://shopify.dev/apps/online-store/theme-app-extensions). \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/app)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { metafields: { type: 'any', description: 'The [metafields](https://shopify.dev/docs/api/liquid/objects/metafield) that are [owned by the app](https://shopify.dev/apps/metafields/app-owned). \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/app/metafields)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, discount: { summary: 'A discount applied to a cart, line item, or order.', deprecated: true, description: '⚠️ **DEPRECATED** ⚠️\n\nDeprecated because not all discount types and details are captured.\n\nThe `discount` object has been replaced by the [`discount_allocation`](/docs/api/liquid/objects/discount_allocation) and\n[`discount_application`](/docs/api/liquid/objects/discount_application) objects.\n\n---\n\nA discount applied to a cart, line item, or order. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { amount: { type: 'number', description: "The amount of the discount in the currency's subunit. \n\n**Note**\n\n> This is the same value as [`discount.total_amount`](https://shopify.dev/docs/api/liquid/objects/discount#discount-total_amount).\n\nThe value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount/amount)\n\n\nLast Updated: 2nd February 2025\n\n\n", deprecated: true }, total_amount: { type: 'number', description: "The amount of the discount in the currency's subunit. \n\n**Note**\n\n> This is the same value as [`discount.amount`](https://shopify.dev/docs/api/liquid/objects/discount#discount-amount).\n\nThe value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount/total_amount)\n\n\nLast Updated: 2nd February 2025\n\n\n", deprecated: true }, code: { type: 'string', description: 'The customer-facing name of the discount. \n\n**Note**\n\n> This is the same value as [`discount.title`](https://shopify.dev/docs/api/liquid/objects/discount#discount-title).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount/code)\n\n\nLast Updated: 2nd February 2025\n\n\n', deprecated: true }, title: { type: 'string', description: 'The customer-facing name of the discount. \n\n**Note**\n\n> This is the same value as [`discount.code`](https://shopify.dev/docs/api/liquid/objects/discount#discount-code).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount/title)\n\n\nLast Updated: 2nd February 2025\n\n\n', deprecated: true }, type: { type: 'string', description: 'The type of the discount. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount/type)\n\n\nLast Updated: 2nd February 2025\n\n\n', deprecated: true, literal: [ 'FixedAmountDiscount', 'PercentageDiscount', 'ShippingDiscount' ] }, savings: { type: 'number', description: "The amount of the discount as a negative value, in the currency's subunit. \n\n**Note**\n\n> This is the same value as [`discount.total_savings`](https://shopify.dev/docs/api/liquid/objects/discount#discount-total_savings).\nThe value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount/savings)\n\n\nLast Updated: 2nd February 2025\n\n\n", deprecated: true }, total_savings: { type: 'number', description: "The amount of the discount as a negative value, in the currency's subunit. \n\n**Note**\n\n> This is the same value as [`discount.savings`](https://shopify.dev/docs/api/liquid/objects/discount#discount-savings).\nThe value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount/total_savings)\n\n\nLast Updated: 2nd February 2025\n\n\n", deprecated: true } } }, articles: { summary: 'All of the articles across the blogs in the store.', global: true, description: "All of the articles across the blogs in the store. \n\n\n\n#### Example\n\nYou can use `articles` to access an article by its [handle](/docs/api/liquid/basics#handles).\n\n\n```liquid\n\n{% assign article = articles['potion-notions/new-potions-for-spring'] %}\n{{ article.title | link_to: article.url }}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/articles)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'array', scope: 'article' }, article: { summary: 'An article, or [blog post](https://help.shopify.com/manual/online-store/blogs/writing-blogs), in a blog.', template: [ 'article' ], description: 'An article, or [blog post](https://help.shopify.com/manual/online-store/blogs/writing-blogs), in a blog. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { image: { type: 'object', description: 'The featured image for the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/image)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'image' }, author: { type: 'string', description: 'The full name of the author of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/author)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, metafields: { type: 'any', description: 'The [metafields](https://shopify.dev/docs/api/liquid/objects/metafield) applied to the article. \n\n**Tip**\n\n> To learn about how to create metafields, refer to [Create and manage metafields](https://shopify.dev/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/metafields)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, handle: { type: 'string', description: 'The [handle](https://shopify.dev/docs/api/liquid/basics#handles) of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/handle)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, id: { type: 'string', description: 'The ID of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, title: { type: 'string', description: 'The title of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/title)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, url: { type: 'string', description: 'The relative URL of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/url)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, template_suffix: { type: 'string', description: "The name of the [custom template](https://shopify.dev/themes/architecture/templates#alternate-templates) assigned to the article. The name doesn't include the `article.` prefix, or the file extension (`.json` or `.liquid`).\n\n If a custom template isn't assigned to the article, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/template_suffix)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, created_at: { type: 'string', description: 'A timestamp for when the article was created. \n\n**Tip**\n\n> Use the [`date` filter](https://shopify.dev/docs/api/liquid/filters/date) to format the timestamp.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/created_at)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, published_at: { type: 'string', description: 'A timestamp for when the article was published. \n\n**Tip**\n\n> Use the [`date` filter](https://shopify.dev/docs/api/liquid/filters/date) to format the timestamp.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/published_at)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, updated_at: { type: 'string', description: 'A timestamp for when the article was updated. \n\n**Tip**\n\n> Use the [`date` filter](https://shopify.dev/docs/api/liquid/filters/date) to format the timestamp.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/updated_at)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, 'moderated?': { type: 'boolean', description: 'Returns `true` if the blog that the article belongs to is set to [moderate comments](https://help.shopify.com/manual/online-store/blogs/managing-comments).\nReturns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/moderated?)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, comments: { type: 'array', description: 'The published comments for the article. Returns an empty array if comments are disabled.\n\n\n\n**Tip**\n\n> Use the [paginate](https://shopify.dev/docs/api/liquid/tags/paginate) tag to choose how many comments to show at once, up to a limit of 50.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/comments)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'comment' }, comments_count: { type: 'number', description: 'The number of published comments for the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/comments_count)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, 'comments_enabled?': { type: 'boolean', description: 'Returns `true` if comments are enabled. Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/comments_enabled?)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, comment_post_url: { type: 'string', description: 'The relative URL where POST requests are sent when creating new comments. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/comment_post_url)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, content: { type: 'string', description: 'The content of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/content)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, excerpt: { type: 'string', description: 'The excerpt of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/excerpt)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, excerpt_or_content: { type: 'string', description: 'Returns the article [excerpt](https://shopify.dev/docs/api/liquid/objects/article#article-excerpt) if it exists. Returns the article\n[content](https://shopify.dev/docs/api/liquid/objects/article#article-content) if no excerpt exists. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/excerpt_or_content)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, tags: { type: 'array', description: 'The tags applied to the article. \n\n\n\n#### Show the total tag count\n\nWhen looping through `article.tags`, you can print how many times a tag is used with `tag.total_count`. This number shows visitors how many blog posts have been tagged with a particular tag.\n\n\n```liquid\n\n{% for tag in article.tags -%}\n {{ tag }} ({{ tag.total_count }})\n{%- endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/tags)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, user: { type: 'object', description: 'The user associated with the author of the article. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/article/user)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'user' } } }, block: { summary: 'The content and settings of a [section block](/themes/architecture/sections/section-schema#blocks).', description: 'The content and settings of a [section block](https://shopify.dev/themes/architecture/sections/section-schema#blocks). Sections and blocks are reusable modules of content that make up [templates](https://shopify.dev/themes/architecture/templates).\n\nYou can include a maxiumum of 50 blocks in a section. To learn more about using blocks, refer to the [Building with sections and blocks](https://shopify.dev/docs/themes/best-practices/templates-sections-blocks).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/block)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { id: { type: 'string', description: 'The ID of the block. The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/block/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, settings: { type: 'any', description: 'The [settings](https://shopify.dev/themes/architecture/sections/section-schema#blocks) of the block. To learn about how to access settings, refer to [Access settings](https://shopify.dev/themes/architecture/settings#access-settings). To learn which input settings can be applied to the `type` property within settings, refer to [Input settings](/themes/architecture/settings/input-settings).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/block/settings)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, type: { type: 'string', description: "The type of the block. The type is a free-form string that's defined in the [block's schema](https://shopify.dev/themes/architecture/sections/section-schema#blocks).\nYou can use the type as an identifier. For example, you might display different markup based on the block type.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/block/type)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, shopify_attributes: { type: 'string', description: "The data attributes for the block for use in the theme editor. The theme editor's [JavaScript API](https://shopify.dev/themes/architecture/sections/integrate-sections-with-the-theme-editor#section-and-block-javascript-events)\nuses the data attributes to identify blocks and listen for events. No value for `block.shopify_attributes` is returned\noutside the theme editor.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/block/shopify_attributes)\n\n\nLast Updated: 2nd February 2025\n\n\n" } } }, blogs: { summary: 'All of the blogs in the store.', global: true, description: 'All of the blogs in the store. \n\n\n\n#### Example\n\nYou can use `blogs` to access a blog by its [handle](/docs/api/liquid/basics#handles).\n\n\n```liquid\n\n{% for article in blogs.potion-notions.articles %}\n {{- article.title | link_to: article.url }}\n{% endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blogs)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'array', scope: 'blog' }, blog: { summary: 'Information about a specific [blog](https://help.shopify.com/manual/online-store/blogs/adding-a-blog) in the store.', template: [ 'blog', 'article' ], description: 'Information about a specific [blog](https://help.shopify.com/manual/online-store/blogs/adding-a-blog) in the store. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { id: { type: 'number', description: 'The ID of the blog. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, title: { type: 'string', description: 'The title of the blog. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/title)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, handle: { type: 'string', description: 'The [handle](https://shopify.dev/docs/api/liquid/basics#handles) of the blog. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/handle)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, articles: { type: 'array', description: 'The articles in the blog. \n\n**Tip**\n\n> Use the [paginate](https://shopify.dev/docs/api/liquid/tags/paginate) tag to choose how many articles to show per page, up to a limit of 50.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/articles)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'article' }, articles_count: { type: 'number', description: "The total number of articles in the blog. This total doesn't include hidden articles. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/articles_count)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, metafields: { type: 'array', description: 'The [metafields](https://shopify.dev/docs/api/liquid/objects/metafield) applied to the blog. \n\n**Tip**\n\n> To learn about how to create metafields, refer to [Create and manage metafields](https://shopify.dev/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/metafields)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'metafield' }, url: { type: 'string', description: 'The relative URL of the blog. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/url)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, template_suffix: { type: 'string', description: "The name of the [custom template](https://shopify.dev/themes/architecture/templates#alternate-templates) assigned to the blog. The name doesn't include the `blog.` prefix, or the file extension (`.json` or `.liquid`).\n\n If a custom template isn't assigned to the blog, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/template_suffix)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, all_tags: { type: 'array', description: "All of the tags on the articles in the blog. This includes tags of articles that aren't in the current pagination view.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/all_tags)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, tags: { type: 'array', description: 'A list of all of the tags on all of the articles in the blog.\n\nUnlike [`blog.all_tags`](https://shopify.dev/docs/api/liquid/objects/blog#blog-all_tags), this property only returns tags of articles that are in the\nfiltered view. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/tags)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, 'comments_enabled?': { type: 'boolean', description: 'Returns `true` if comments are enabled for the blog. Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/comments_enabled?)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, 'moderated?': { type: 'boolean', description: 'Returns `true` if the blog is set to\n[moderate comments](https://help.shopify.com/manual/online-store/blogs/managing-comments). Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/moderated?)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, next_article: { type: 'object', description: 'The next (older) article in the blog. Returns `nil` if there is no next article.\n\nThis property can be used on the [article page](https://shopify.dev/themes/architecture/templates/article) to output `next` links.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/next_article)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'article' }, previous_article: { type: 'object', description: 'The previous (newer) article in the blog. Returns `nil` if there is no previous article.\n\nThis property can be used on the [article page](https://shopify.dev/themes/architecture/templates/article) to output `previous` links.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/blog/previous_article)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'article' } } }, brand: { summary: 'The [brand assets](https://help.shopify.com/manual/promoting-marketing/managing-brand-assets) for the store.', description: 'The [brand assets](https://help.shopify.com/manual/promoting-marketing/managing-brand-assets) for the store. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { slogan: { type: 'string', description: 'The slogan for the brand. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/slogan)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, short_description: { type: 'string', description: 'A short description of the brand. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/short_description)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, favicon_url: { type: 'object', description: 'The square logo for the brand, resized to 32x32 px. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/favicon_url)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'image' }, cover_image: { type: 'object', description: 'The square logo for the brand, resized to 32x32 px. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/cover_image)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'image' }, logo: { type: 'object', description: 'The default logo for the brand. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/logo)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'image' }, square_logo: { type: 'object', description: 'The square logo for the brand. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/square_logo)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'image' }, colors: { type: 'any', description: "The brand's colors. To learn about how to access brand colors, refer to [`brand_color`](https://shopify.dev/docs/api/liquid/objects/brand_color).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/colors)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, metafields: { type: 'any', description: 'The social links for the brand. Social links are stored in [metafields](https://shopify.dev/docs/api/liquid/objects/metafield), and can be accessed using the syntax `shop.brand.metafields.social_links..value`.\n\n| Platforms |\n| --- |\n| `facebook` |\n| `pinterest` |\n| `instagram` |\n| `tiktok` |\n| `tumblr` |\n| `snapchat` |\n| `vimeo` |\n\n#### Access social links\n\n```liquid\n\n{{ shop.brand.metafields.social_links.twitter.value }}\n{{ shop.brand.metafields.social_links.youtube.value }}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand/metafields)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, cart: { summary: 'A customer’s cart.', global: true, template: [ 'cart' ], description: 'A customer’s cart. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { requires_shipping: { type: 'boolean', description: 'Returns `true` if any of the products in the cart require shipping. Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/requires_shipping)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, note: { type: 'string', description: 'Additional information captured with the cart. To learn more about capturing cart notes, refer to the [`cart` template](https://shopify.dev/themes/architecture/templates/cart#support-cart-notes-and-attributes).\n\n#### Capture cart notes\n\nTo capture a cart note, include an HTML input such as a `\n```\n\n> Note:\n> There can only be one instance of `{{ cart.note }}` on the cart page. If there are multiple instances,\n> then the one that comes latest in the Document Object Model (DOM) will be submitted with the form.\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/note)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, item_count: { type: 'number', description: 'The number of items in the cart. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/item_count)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, total_price: { type: 'number', description: "The total price of all of the items in the cart in the currency's subunit, after discounts have been applied. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/total_price)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, checkout_charge_amount: { type: 'number', description: "The amount that the customer will be charged at checkout in the currency's subunit. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted price.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/checkout_charge_amount)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, original_total_price: { type: 'number', description: "The total price of all of the items in the cart in the currency's subunit, before discounts have been applied. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/original_total_price)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, items_subtotal_price: { type: 'number', description: "The total price of all of the items in the cart in the currency's subunit, after any line item discounts. This\ndoesn't include taxes (unless taxes are included in the prices), cart discounts, or shipping costs. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/items_subtotal_price)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, total_discount: { type: 'number', description: "The total amount of all discounts (the amount saved) for the cart in the currency's subunit. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/total_discount)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, items: { type: 'array', description: 'The line items in the cart. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/items)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'line_item' }, 'empty?': { type: 'boolean', description: "Returns `true` if there are no items in the cart. Return's `false` if there are. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/empty?)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, currency: { type: 'any', description: "The currency of the cart. If the store uses multi-currency, then this is the same as the customer's local\n(presentment) currency. Otherwise, it's the same as the store currency.\n\n\n\n**Tip**\n\n> You can output the store's available currencies using [`shop.enabled_currencies`](https://shopify.dev/docs/api/liquid/objects/shop#shop-enabled_currencies).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/currency)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, total_weight: { type: 'number', description: "The total weight of all of the items in the cart in grams. \n\n**Tip**\n\n> Use the [`weight_with_unit`](https://shopify.dev/docs/api/liquid/filters/weight_with_unit) filter to format the weight in\n> [the store's format](https://www.shopify.com/admin/settings/general), or override the default unit.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/total_weight)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, discount_applications: { type: 'array', description: 'The discount applications for the cart. \n\n\n\n#### Display discount applications\n\n```liquid\n\n{% for discount_application in cart.discount_applications %}\n Discount name: {{ discount_application.title }}\n Savings: -{{ discount_application.total_allocated_amount | money }}\n{% endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/discount_applications)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'discount_application' }, attributes: { type: 'any', description: "Additional attributes entered by the customer with the cart. To learn more about capturing cart attributes, refer to the [`cart` template](https://shopify.dev/themes/architecture/templates/cart#support-cart-notes-and-attributes).\n\n#### Capture cart attributes\n\nTo capture a cart attribute, include an HTML input with an attribute of `name=\"attributes[attribute-name]\"` within the cart `
`.\n\n```liquid\n\n\n```\n\n> Tip:\n> You can add a double underscore `__` prefix to an attribute name to make it private. Private attributes behave like other cart attributes, except that they can't be read from Liquid or the Ajax API.\n> You can use them for data that doesn't affect the page rendering, which allows for more effective page caching.\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/attributes)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, cart_level_discount_applications: { type: 'array', description: 'The cart-specific discount applications for the cart. \n\n\n\n#### Display cart-level discount applications\n\n```liquid\n\n{% for discount_application in cart.cart_level_discount_applications %}\n Discount name: {{ discount_application.title }}\n Savings: -{{ discount_application.total_allocated_amount | money }}\n{% endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/cart_level_discount_applications)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'discount_application' }, discounts: { type: 'array', description: '⚠️ **DEPRECATED** ⚠️\n\nDeprecated because not all discount types and details are available.\n\nThe `cart.discounts` property has been replaced by [`cart.discount_applications`](/docs/api/liquid/objects/cart#cart-discount_applications).\n\n---\n\nThe discounts applied to the cart. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/discounts)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'discount' }, taxes_included: { type: 'boolean', description: 'Returns `true` if taxes are included in the prices of products in the cart. Returns `false` if not. This can be set in a store’s [tax settings](https://www.shopify.com/admin/settings/taxes).\n\nIf the store includes or exclude tax [based on the customer’s country](https://help.shopify.com/manual/taxes/location#include-or-exclude-tax-based-on-your-customers-country),\nthen the value reflects the tax requirements of the customer’s country.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/taxes_included)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, duties_included: { type: 'boolean', description: 'Returns `true` if duties are included in the prices of products in the cart. Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/cart/duties_included)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, closest: { summary: 'A drop that holds resources of different types that are the closest to the current context', global: true, description: "A drop that holds resources of different types that are the closest to the current context This drop is used to hold resources of different types that are the closest to the current context. These resources can be of type `product`, `collection`, `article`, `blog`, `page`, or `metaobject`.\nThe resources of different types within the closest drop can be:\n - The currently rendered section or theme block resource setting of the same type\n - The currently rendered theme block's ancestor resource setting of the same type\n - The currently rendered template resource of the same type\n - Assigned via {% content_for %} tag\n\n\n\n**Tip**\n\n> To learn about how closest drop in theme settings can be used, refer to [Dynamic sources](https://shopify.dev/themes/architecture/blocks/theme-blocks/dynamic-sources).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/closest)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'object', properties: { product: { type: 'object', description: 'Closest product resource The product resource that is the closest to the current context.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/closest/product)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'product' }, collection: { type: 'object', description: 'Closest collection resource The collection resource that is the closest to the current context.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/closest/collection)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'collection' }, article: { type: 'object', description: 'Closest article resource The article resource that is the closest to the current context.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/closest/article)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'article' }, blog: { type: 'object', description: 'Closest blog resource The blog resource that is the closest to the current context.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/closest/blog)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'blog' }, page: { type: 'object', description: 'Closest page resource The page resource that is the closest to the current context.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/closest/page)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'page' }, metaobject: { type: 'object', description: 'Closest metaobject resources The metaobject resources that are the closest to the current context.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/closest/metaobject)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'metaobject' } } }, collection: { summary: 'A [collection](https://help.shopify.com/manual/products/collections) in a store.', template: [ 'collection' ], description: 'A [collection](https://help.shopify.com/manual/products/collections) in a store. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { metafields: { type: 'array', description: 'The [metafields](https://shopify.dev/docs/api/liquid/objects/metafield) applied to the collection. \n\n**Tip**\n\n> To learn about how to create metafields, refer to [Create and manage metafields](https://shopify.dev/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/metafields)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'metafield' }, id: { type: 'number', description: 'The ID of the collection. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, handle: { type: 'string', description: 'The [handle](https://shopify.dev/docs/api/liquid/basics#handles) of the collection. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/handle)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, title: { type: 'string', description: 'The title of the collection. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/title)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, description: { type: 'string', description: 'The description of the collection. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/description)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, template_suffix: { type: 'string', description: "The name of the [custom template](https://shopify.dev/themes/architecture/templates#alternate-templates) assigned to the collection. The name doesn't include the `collection.` prefix, or the file extension (`.json` or `.liquid`).\n\n If a custom template isn't assigned to the collection, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/template_suffix)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, current_vendor: { type: 'string', description: 'The vendor name on a vendor collection page. You can query for products from a certain vendor at the `/collections/vendors` URL\nwith a query parameter in the format of `?q=[vendor]`, where `[vendor]` is your desired product vendor.\n\n\n\n**Tip**\n\n> The query value is case-insensitive, so `apparelco` is equivalent to `ApparelCo` or `APPARELCO`.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/current_vendor)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, current_type: { type: 'string', description: 'The product type on a product type collection page. You can query for products of a certain type at the `/collections/types` URL\nwith a query parameter in the format of `?q=[type]`, where `[type]` is your desired product type.\n\n\n\n**Tip**\n\n> The query value is case-insensitive, so `shirts` is equivalent to `Shirts` or `SHIRTS`.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/current_type)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, url: { type: 'string', description: 'The relative URL of the collection. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/url)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, published_at: { type: 'string', description: 'A timestamp for when the collection was published. \n\n**Tip**\n\n> Use the [`date` filter](https://shopify.dev/docs/api/liquid/filters/date) to format the timestamp.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/published_at)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, image: { type: 'object', description: "The image for the collection. This image is added on the collection's page in the Shopify admin.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/image)\n\n\nLast Updated: 2nd February 2025\n\n\n", scope: 'image' }, sort_options: { type: 'array', description: 'The available sorting options for the collection. \n\n\n\n#### Output the sort options\n\n```liquid\n\n{%- assign sort_by = collection.sort_by | default: collection.default_sort_by -%}\n\n\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/sort_options)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'sort_option' }, sort_by: { type: 'string', description: "The sort order applied to the collection by the `sort_by` URL parameter. If there's no `sort_by` URL parameter, then the value is `nil`.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/sort_by)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, default_sort_by: { type: 'string', description: "The default sort order of the collection. This is set on the collection's page in the Shopify admin.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/default_sort_by)\n\n\nLast Updated: 2nd February 2025\n\n\n", literal: [ 'manual', 'best-selling', 'title-ascending', 'price-ascending', 'price-descending', 'created-ascending', 'created-descending' ] }, next_product: { type: 'object', description: "The next product in the collection. Returns `nil` if there's no next product. This property can be used on the [product page](https://shopify.dev/themes/architecture/templates/product) to output `next` links.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/next_product)\n\n\nLast Updated: 2nd February 2025\n\n\n", scope: 'product' }, previous_product: { type: 'object', description: "The previous product in the collection. Returns `nil` if there's no previous product. This property can be used on the [product page](https://shopify.dev/themes/architecture/templates/product) to output `previous` links.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/previous_product)\n\n\nLast Updated: 2nd February 2025\n\n\n", scope: 'product' }, products_count: { type: 'number', description: 'The total number of products in the current view of the collection. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/products_count)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, products: { type: 'array', description: 'All of the products in the collection. \n\n**Tip**\n\n> Use the [paginate](https://shopify.dev/docs/api/liquid/tags/paginate) tag to choose how many products to show per page, up to a limit of 50.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/products)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'product' }, all_products_count: { type: 'number', description: 'The total number of products in a collection. This includes products that have been filtered out of the current view.\n\n\n\n**Tip**\n\n> To display the number of products in a filtered collection, use [`collection.products_count`](https://shopify.dev/docs/api/liquid/objects/collection#collection-products_count).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/all_products_count)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, all_tags: { type: 'array', description: '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.\nA maximum of 1,000 tags can be returned.\n\n\n\n**Tip**\n\n> To display the tags that are currently applied, use [`collection.tags`](https://shopify.dev/docs/api/liquid/objects/collection#collection-tags).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/all_tags)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, tags: { type: 'array', description: "The tags that are currently applied to the collection. This doesn't include tags for products that have been filtered out of the current view.\nReturns `nil` if no tags have been applied, or all products with tags have been filtered out of the current view.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/tags)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, all_types: { type: 'array', description: 'All of the product types in a collection. \n\n\n\n#### Create links to product types\n\nUse the [`link_to_type`](/docs/api/liquid/filters/link_to_type) filter to create links to the product types in a collection.\n\n\n```liquid\n\n{% for product_type in collection.all_types -%}\n {{- product_type | link_to_type }}\n{%- endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/all_types)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, all_vendors: { type: 'array', description: 'All of the product vendors in a collection. \n\n\n\n#### Create links to vendors\n\nUse the [`link_to_vendor`](/docs/api/liquid/filters/link_to_vendor) filter to create links to the vendors in a collection.\n\n\n```liquid\n\n{% for product_vendor in collection.all_vendors %}\n {{- product_vendor | link_to_vendor }}\n{% endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/all_vendors)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, filters: { type: 'array', description: 'The [storefront filters](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters) that\nhave been set up on the collection. Only filters relevant to the current collection are returned. Filters will be empty for collections that contain over 5000 products.\n\nTo learn about supporting filters in your theme, refer to [Support storefront filtering](https://shopify.dev/themes/navigation-search/filtering/storefront-filtering/support-storefront-filtering).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/filters)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'filter' }, featured_image: { type: 'object', description: "The featured image for the collection. The default is the [collection image](https://shopify.dev/docs/api/liquid/objects/collection#collection-image). If this image isn't available, then\nShopify falls back to the featured image of the first product in the collection. If the first product in the collection\ndoesn't have a featured image, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/collection/featured_image)\n\n\nLast Updated: 2nd February 2025\n\n\n", scope: 'image' } } }, brand_color: { summary: "The colors defined as part of a store's [brand assets](https://help.shopify.com/manual/promoting-marketing/managing-brand-assets).", description: "The colors defined as part of a store's [brand assets](https://help.shopify.com/manual/promoting-marketing/managing-brand-assets). \n\n\n\n#### Example\n\nTo access a brand color, specify the following:\n- The brand color group: either `primary` or `secondary`\n- The color role: Whether the color is a `background` or `foreground` (contrasting) color\n- The 0-based index of the color within the group and role\n\n\n```liquid\n\n{{ shop.brand.colors.primary[0].background }}\n{{ shop.brand.colors.primary[0].foreground }}\n{{ shop.brand.colors.secondary[0].background }}\n{{ shop.brand.colors.secondary[1].background }}\n{{ shop.brand.colors.secondary[0].foreground }}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/brand_color)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'string', const: true }, color: { summary: 'A color from a [`color` setting](/themes/architecture/settings/input-settings#color).', description: 'A color from a [`color` setting](https://shopify.dev/themes/architecture/settings/input-settings#color). \n\n**Tip**\n\n> Use [color filters](https://shopify.dev/docs/api/liquid/filters/color-filters) to modify or extract properties of a `color` object.\n\n#### Referencing color settings directly\n\nWhen a color setting is referenced directly, the hexidecimal color code is returned.\n\n\n```liquid\n\n{{ settings.colors_accent_2 }}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { red: { type: 'number', description: 'The red component of the color, which is a number between 0 and 255. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/red)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, green: { type: 'number', description: 'The green component of the color, which is a number between 0 and 255. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/green)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, blue: { type: 'number', description: 'The blue component of the color, which is a number between 0 and 255. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/blue)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, rgb: { type: 'string', description: 'The red, green, and blue values of the color, represented as a space-separated string. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/rgb)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, rgba: { type: 'string', description: 'The red, green, blue, and alpha values of the color, represented as a\nspace-separated string, with a slash before the alpha channel. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/rgba)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, hue: { type: 'number', description: 'The hue component of the color, which is a number between 0 and 360. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/hue)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, saturation: { type: 'number', description: 'The saturation component of the color, which is a number between 0 and 100. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/saturation)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, lightness: { type: 'number', description: 'The lightness component of the color, which is a number between 0 and 100. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/lightness)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, alpha: { type: 'number', description: 'The alpha component of the color, which is a decimal number between 0.0 and 1.0. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color/alpha)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, color_scheme: { summary: 'A color_scheme from a [`color_scheme` setting](/themes/architecture/settings/input-settings#color_scheme).', description: 'A color_scheme from a [`color_scheme` setting](https://shopify.dev/themes/architecture/settings/input-settings#color_scheme). \n\n**Tip**\n\n> To learn about color scheme groups in themes, refer to [`color_scheme_group` setting](https://shopify.dev/themes/architecture/settings/input-settings#color_scheme_group).\n\n#### Referencing color_scheme settings directly\n\nWhen a color_scheme setting is referenced directly, the color scheme ID is returned.\n\n\n```liquid\n\n{{ settings.card_color_scheme }}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color_scheme)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { id: { type: 'string', description: 'The ID of the color_scheme \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color_scheme/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, settings: { type: 'any', description: 'The [settings](https://shopify.dev/docs/themes/architecture/settings/input-settings#color_scheme_group) of the color_scheme. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color_scheme/settings)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, color_scheme_group: { summary: 'A color_scheme_group from a [`color_scheme_group` setting](/themes/architecture/settings/input-settings#color_scheme_group).', description: 'A color_scheme_group from a [`color_scheme_group` setting](https://shopify.dev/themes/architecture/settings/input-settings#color_scheme_group). \n\n**Tip**\n\n> To learn about color schemes in themes, refer to [`color_scheme` setting](https://shopify.dev/themes/architecture/settings/input-settings#color_scheme).\n\n#### Referencing color_scheme_group settings directly\n\n```liquid\n\n{% for scheme in settings.color_schemes %}\n .color-{{ scheme.id }} {\n --color-background: {{ scheme.settings.background }};\n --color-text: {{ scheme.settings.text }};\n }\n{% endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/color_scheme_group)\n\n\nLast Updated: 2nd February 2025\n\n\n', const: true }, company_address: { summary: 'The address of a company location.', description: 'The address of a company location. To learn about B2B in themes, refer to [Support B2B customers in your theme](https://shopify.dev/themes/pricing-payments/b2b).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { attention: { type: 'string', description: 'The attention line of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/attention)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, id: { type: 'number', description: 'The ID of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, address1: { type: 'string', description: 'The first line of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/address1)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, address2: { type: 'string', description: 'The second line of the address. If no second line is specified, then `nil` is returned.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/address2)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, first_name: { type: 'string', description: 'The first name of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/first_name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, last_name: { type: 'string', description: 'The last name of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/last_name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, city: { type: 'string', description: 'The city of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/city)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, zip: { type: 'string', description: 'The zip or postal code of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/zip)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, country_code: { type: 'string', description: 'The country of the address in [ISO 3166-1 (alpha 2) format](https://www.iso.org/glossary-for-iso-3166.html). \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/country_code)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, province_code: { type: 'string', description: "The province of the address in [ISO 3166-2 (alpha 2) format](https://www.iso.org/glossary-for-iso-3166.html). \n\n**Note**\n\n> The value doesn't include the preceding [ISO 3166-1](https://www.iso.org/glossary-for-iso-3166.html) country code.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/province_code)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, country: { type: 'object', description: 'The country of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/country)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'country' }, street: { type: 'string', description: 'A combination of the first and second lines of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/street)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, province: { type: 'string', description: 'The province of the address. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_address/province)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, company: { summary: 'A company that a [customer](/docs/api/liquid/objects/customer) is purchasing for.', description: 'A company that a [customer](https://shopify.dev/docs/api/liquid/objects/customer) is purchasing for. To learn about B2B in themes, refer to [Support B2B customers in your theme](https://shopify.dev/themes/pricing-payments/b2b).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { id: { type: 'number', description: 'The ID of the company. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, name: { type: 'string', description: 'The name of the company. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company/name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, external_id: { type: 'string', description: 'The external ID of the company. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company/external_id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, available_locations: { type: 'array', description: 'The company locations that the current customer has access to, or can interact with. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company/available_locations)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'company_location' }, available_locations_count: { type: 'number', description: "The number of company locations associated with the customer's company. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company/available_locations_count)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, metafields: { type: 'array', description: 'The [metafields](https://shopify.dev/docs/api/liquid/objects/metafield) applied to the company. \n\n**Tip**\n\n> To learn about how to create metafields, refer to [Create and manage metafields](https://shopify.dev/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company/metafields)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'metafield' } } }, company_location: { summary: 'A location of the [company](/docs/api/liquid/objects/company) that a [customer](/docs/api/liquid/objects/customer) is purchasing for.', description: 'A location of the [company](https://shopify.dev/docs/api/liquid/objects/company) that a [customer](https://shopify.dev/docs/api/liquid/objects/customer) is purchasing for. To learn about B2B in themes, refer to [Support B2B customers in your theme](https://shopify.dev/themes/pricing-payments/b2b).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { id: { type: 'number', description: 'The ID of the location. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, name: { type: 'string', description: 'The name of the location. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, external_id: { type: 'string', description: 'The external ID of the location. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/external_id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, url_to_set_as_current: { type: 'string', description: 'The URL to set the location as the current location for the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/url_to_set_as_current)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, 'current?': { type: 'boolean', description: 'Returns `true` if the location is currently selected. Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/current?)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, company: { type: 'object', description: 'The company that the location is associated with. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/company)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'company' }, shipping_address: { type: 'object', description: 'The address of the location. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/shipping_address)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'company_address' }, tax_registration_id: { type: 'number', description: 'The tax ID of the location. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/tax_registration_id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, metafields: { type: 'array', description: 'The [metafields](https://shopify.dev/docs/api/liquid/objects/metafield) applied to the company location. \n\n**Tip**\n\n> To learn about how to create metafields, refer to [Create and manage metafields](https://shopify.dev/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/company_location/metafields)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'metafield' } } }, content_for_header: { summary: 'Dynamically returns all scripts required by Shopify.', global: true, description: "Dynamically returns all scripts required by Shopify. Include the `content_for_header` object in your [layout files](https://shopify.dev/themes/architecture/layouts) between the `` and\n`` HTML tags.\n\nYou shouldn't try to modify or parse the `content_for_header` object because the contents are subject to change, which can\nchange the behaviour of your code.\n\n\n\n**Note**\n\n> The `content_for_header` object is required in `theme.liquid`.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/content_for_header)\n\n\nLast Updated: 2nd February 2025\n\n\n", const: true }, country: { summary: "A country supported by the store's localization options.", description: "A country supported by the store's localization options. To learn how to use the `country` object to offer localization options in your theme,\nrefer to [Support multiple currencies and languages](https://shopify.dev/themes/internationalization/multiple-currencies-languages).\n\n#### Referencing the `country` object directly\n\nWhen the country object is referenced directly, `country.name` is returned.\n\n\n```liquid\n\n{% for country in localization.available_countries -%}\n {{ country }}\n{%- endfor %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'object', properties: { name: { type: 'string', description: 'The name of the country. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, iso_code: { type: 'string', description: 'The ISO code of the country in [ISO 3166-1 (alpha 2) format](https://www.iso.org/glossary-for-iso-3166.html). \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/iso_code)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, unit_system: { type: 'string', description: 'The unit system of the country. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/unit_system)\n\n\nLast Updated: 2nd February 2025\n\n\n', literal: [ 'imperial', 'metric' ] }, currency: { type: 'object', description: 'The currency used in the country. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/currency)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'currency' }, market: { type: 'object', description: 'The market that includes this country. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/market)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'market' }, 'popular?': { type: 'boolean', description: 'Returns `true` if the country is popular for this shop. Otherwise, returns `false`.\nThis can be useful for sorting countries in a country selector. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/popular?)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, continent: { type: 'string', description: 'The continent that the country is in. Possible values are `Africa`, `Asia`, `Central America`, `Europe`, `North America`, `Oceania`, and `South America`.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/continent)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, available_languages: { type: 'array', description: 'The languages that have been added to the market that this country belongs to. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/country/available_languages)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'shop_locale' } } }, currency: { summary: 'Information about a currency, like the ISO code and symbol.', description: 'Information about a currency, like the ISO code and symbol. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/currency)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { iso_code: { type: 'string', description: 'The [ISO code](https://www.iso.org/iso-4217-currency-codes.html) of the currency. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/currency/iso_code)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, symbol: { type: 'string', description: 'The symbol of the currency. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/currency/symbol)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, name: { type: 'string', description: 'The name of the currency. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/currency/name)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, customer: { summary: 'A [customer](https://help.shopify.com/manual/customers) of the store.', global: true, template: [ 'customers/account', 'customers/addresses', 'customers/order' ], description: "A [customer](https://help.shopify.com/manual/customers) of the store. The `customer` object is directly accessible globally when a customer is logged in to their account. It's also defined in\nthe following contexts:\n\n- The [`customers/account` template](https://shopify.dev/themes/architecture/templates/customers-account)\n- The [`customers/addresses` template](https://shopify.dev/themes/architecture/templates/customers-addresses)\n- The [`customers/order` template](https://shopify.dev/themes/architecture/templates/customers-order)\n- When accessing [`checkout.customer`](https://shopify.dev/docs/api/liquid/objects/checkout#checkout-customer)\n- When accessing [`gift_card.customer`](https://shopify.dev/docs/api/liquid/objects/gift_card#gift_card-customer)\n- When accessing [`order.customer`](https://shopify.dev/docs/api/liquid/objects/order#order-customer)\n\nOutside of the above contexts, if the customer isn't logged into their account, the `customer` object returns `nil`.\n\n#### Check whether the `customer` object is defined\n\nWhen using the `customer` object outside of customer-specific templates or objects that specifically return a customer, you should check whether the `customer` object is defined.\n\n\n```liquid\n\n{% if customer %}\n Hello, {{ customer.first_name }}!\n{% endif %}\n\n```\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'object', properties: { first_name: { type: 'string', description: 'The first name of the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/first_name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, last_name: { type: 'string', description: 'The last name of the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/last_name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, orders_count: { type: 'number', description: 'The total number of orders that the customer has placed. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/orders_count)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, total_spent: { type: 'number', description: "The total amount that the customer has spent on all orders in the currency's subunit. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/total_spent)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, orders: { type: 'array', description: 'All of the orders placed by the customer. \n\n**Tip**\n\n> Use the [paginate](https://shopify.dev/docs/api/liquid/tags/paginate) tag to choose how many orders to show at once, up to a limit of 20.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/orders)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'order' }, last_order: { type: 'object', description: 'The last order placed by the customer, not including test orders. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/last_order)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'order' }, name: { type: 'string', description: 'The full name of the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/name)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, email: { type: 'string', description: 'The email of the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/email)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, phone: { type: 'string', description: 'The phone number of the customer. This phone number is only populated if the customer checks out using a phone number during checkout, opts in to SMS\nnotifications, or if the merchant has manually entered it.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/phone)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, has_account: { type: 'boolean', description: "Returns `true` if the email associated with the customer is tied to a\n[customer account](https://help.shopify.com/manual/customers/customer-accounts). Returns `false` if not. A customer can complete a checkout without making an account with the store. If the customer\ndoesn't have an account with the store, then `customer.has_account` is `false` at checkout.\n\nDuring the checkout process, if the customer has an account with the store and enters an email associated\nwith an account, then `customer.has_account` is `true`. The email is associated with the account regardless\nof whether the customer has logged into their account.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/has_account)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, accepts_marketing: { type: 'boolean', description: 'Returns `true` if the customer accepts marketing. Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/accepts_marketing)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, id: { type: 'number', description: 'The ID of the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/id)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, tags: { type: 'array', description: 'The tags associated with the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/tags)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, default_address: { type: 'object', description: 'The default address of the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/default_address)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'address' }, addresses: { type: 'array', description: 'All of the addresses associated with the customer. \n\n**Tip**\n\n> Use the [paginate](https://shopify.dev/docs/api/liquid/tags/paginate) tag to choose how many addresses to show at once, up to a limit of 20.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/addresses)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'address' }, addresses_count: { type: 'number', description: 'The number of addresses associated with the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/addresses_count)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, tax_exempt: { type: 'boolean', description: 'Returns `true` if the customer is exempt from taxes. Returns `false` if not. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/tax_exempt)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, payment_methods: { type: 'array', description: "The customer's saved payment methods. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/payment_methods)\n\n\nLast Updated: 2nd February 2025\n\n\n", scope: 'customer_payment_method' }, 'b2b?': { type: 'boolean', description: 'Returns `true` if the customer is a B2B customer. Returns `false` if not. To learn about B2B in themes, refer to [Support B2B customers in your theme](https://shopify.dev/themes/pricing-payments/b2b).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/b2b?)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, company_available_locations: { type: 'array', description: 'The company locations that the customer has access to, or can interact with. To learn about B2B in themes, refer to [Support B2B customers in your theme](https://shopify.dev/themes/pricing-payments/b2b).\n\n\n\n**Tip**\n\n> Use the [paginate](https://shopify.dev/docs/api/liquid/tags/paginate) tag to choose how many company locations to show at once, up to a limit of 100.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/company_available_locations)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'company_location' }, company_available_locations_count: { type: 'number', description: 'The number of company locations associated with the customer. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/company_available_locations_count)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, current_location: { type: 'object', description: 'The currently selected company location. To learn about B2B in themes, refer to [Support B2B customers in your theme](https://shopify.dev/themes/pricing-payments/b2b).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/current_location)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'company_location' }, current_company: { type: 'object', description: 'The company that the customer is purchasing for. To learn about B2B in themes, refer to [Support B2B customers in your theme](https://shopify.dev/themes/pricing-payments/b2b).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/current_company)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'company' }, 'has_avatar?': { type: 'boolean', description: "Returns `true` if an avatar is associated with a customer. Returns `false` if not. A customer may have an avatar associated with their account, which can be displayed in the storefront.\n\n\n\n**Tip**\n\n> Use with the [`avatar`](https://shopify.dev/docs/api/liquid/filters/avatar) filter to render the customer's avatar.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer/has_avatar?)\n\n\nLast Updated: 2nd February 2025\n\n\n" } } }, customer_payment_method: { summary: "A customer's saved payment method.", description: "A customer's saved payment method. A payment method that a customer has saved to their account for reuse (e.g. a credit card).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer_payment_method)\n\n\nLast Updated: 2nd February 2025\n\n\n", type: 'object', properties: { payment_instrument_type: { type: 'string', description: 'The instrument type of the payment method (e.g credit_card). \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer_payment_method/payment_instrument_type)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, token: { type: 'string', description: 'The identifier for the payment method. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/customer_payment_method/token)\n\n\nLast Updated: 2nd February 2025\n\n\n' } } }, discount_allocation: { summary: 'Information about how a discount affects an item.', description: 'Information about how a discount affects an item. To learn about how to display discounts in your theme, refer to [Discounts](https://shopify.dev/themes/pricing-payments/discounts).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_allocation)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { discount_application: { type: 'object', description: 'The discount application that applies the discount to the item. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_allocation/discount_application)\n\n\nLast Updated: 2nd February 2025\n\n\n', scope: 'discount_application' }, amount: { type: 'number', description: "The amount that the item is discounted by in the currency's subunit. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_allocation/amount)\n\n\nLast Updated: 2nd February 2025\n\n\n" } } }, discount_application: { summary: 'Information about the intent of a discount.', description: 'Information about the intent of a discount. To learn about how to display discounts in your theme, refer to [Discounts](https://shopify.dev/themes/pricing-payments/discounts).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application)\n\n\nLast Updated: 2nd February 2025\n\n\n', type: 'object', properties: { total_allocated_amount: { type: 'number', description: "The total amount of the discount in the currency's subunit. The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted amount.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application/total_allocated_amount)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, title: { type: 'string', description: 'The customer-facing name of the discount. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application/title)\n\n\nLast Updated: 2nd February 2025\n\n\n' }, value: { type: 'number', description: "The value of the discount. How this value is interpreted depends on the [value type](https://shopify.dev/docs/api/liquid/objects/discount_application#discount_application-value_type) of the\ndiscount. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount of the discount in the currency's subunit. |\n| `percentage` | The percent amount of the discount. |\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n\n\n**Tip**\n\n> Use [money filters](https://shopify.dev/docs/api/liquid/filters/money-filters) to output a formatted price.\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application/value)\n\n\nLast Updated: 2nd February 2025\n\n\n" }, target_selection: { type: 'string', description: "The selection method for line items or shipping lines to be discounted. \n\n**Note**\n\n> Whether the selection method applies to line items or shipping lines depends on the discount's\n> [target type](https://shopify.dev/docs/api/liquid/objects/discount_application#discount_application-target_type).\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application/target_selection)\n\n\nLast Updated: 2nd February 2025\n\n\n", literal: [ 'all', 'entitled', 'explicit' ] }, type: { type: 'string', description: 'The type of the discount. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application/type)\n\n\nLast Updated: 2nd February 2025\n\n\n', literal: [ 'automatic', 'discount_code', 'manual', 'script' ] }, value_type: { type: 'string', description: 'The value type of the discount. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application/value_type)\n\n\nLast Updated: 2nd February 2025\n\n\n', literal: [ 'fixed_amount', 'percentage' ] }, target_type: { type: 'string', description: 'The type of item that the discount applies to. \n\n\n\n---\n\n[Shopify Liquid](https://shopify.dev/docs/api/liquid/objects/discount_application/target_type)\n\n\nLast Updated: 2nd February 2025\n\n\n', literal: [ 'line_item', 'shipping_line' ] } } }, external_video: { summary: 'Information about an external video from YouTube or Vimeo.', description: 'Information about an external video from YouTube or Vimeo. \n\n**Tip**\n\n> Use the [`external_video_tag` filter](https://shopify.dev/docs/api/liquid/filters/external_video_tag) to output the video in an\n> HTML `