diff --git a/data/filters.json b/data/filters.json index 5d59562..97a13ad 100644 --- a/data/filters.json +++ b/data/filters.json @@ -133,7 +133,7 @@ "category": "collection", "deprecated": false, "deprecation_reason": "", - "description": "Accepts the following values:\n\n- `manual`\n- `best-selling`\n- `title-ascending`\n- `title-descending`\n- `price-ascending`\n- `price-descending`\n- `created-ascending`\n- `created-descending`\n\n> Tip:\n> You can append the `sort_by` filter to the [`url_for_type`](/api/liquid/filters/url_for_type)\n> and [`url_for_vendor`](/api/liquid/filters/url_for_vendor) filters.", + "description": "Accepts the following values:\n\n- `manual`\n- `best-selling`\n- `title-ascending`\n- `title-descending`\n- `price-ascending`\n- `price-descending`\n- `created-ascending`\n- `created-descending`\n\n> Tip:\n> You can append the `sort_by` filter to the [`url_for_type`](/docs/api/liquid/filters/url_for_type)\n> and [`url_for_vendor`](/docs/api/liquid/filters/url_for_vendor) filters.", "parameters": [ ], @@ -229,7 +229,7 @@ "category": "collection", "deprecated": false, "deprecation_reason": "", - "description": "When the collection context is included, you can access the associated [`collection` object](/api/liquid/objects/collection)\nin the [product template](/themes/architecture/templates/product).\n\n> Caution:\n> Because a standard product page and a product page in the context of a collection have the same content on separate\n> URLs, you should consider the SEO implications of using the `within` filter.", + "description": "When the collection context is included, you can access the associated [`collection` object](/docs/api/liquid/objects/collection)\nin the [product template](/themes/architecture/templates/product).\n\n> Caution:\n> Because a standard product page and a product page in the context of a collection have the same content on separate\n> URLs, you should consider the SEO implications of using the `within` filter.", "parameters": [ ], @@ -814,7 +814,7 @@ { "category": "color", "deprecated": true, - "deprecation_reason": "The `hex_to_rgba` filter has been replaced by [`color_to_rgb`](/api/liquid/filters/color_to_rgb) and\n[`color_modify`](/api/liquid/filters/color_modify).", + "deprecation_reason": "The `hex_to_rgba` filter has been replaced by [`color_to_rgb`](/docs/api/liquid/filters/color_to_rgb) and\n[`color_modify`](/docs/api/liquid/filters/color_modify).", "description": "", "parameters": [ { @@ -1023,8 +1023,8 @@ { "category": "localization", "deprecated": true, - "deprecation_reason": "Deprecated without a direct replacement because the [currency form](/api/liquid/tags/form#form-currency) has also been\ndeprecated.", - "description": "The `currency_selector` filter must be applied to the [`form` object](/api/liquid/objects/form) within a\n[currency form](/api/liquid/tags/form#form-currency).", + "deprecation_reason": "Deprecated without a direct replacement because the [currency form](/docs/api/liquid/tags/form#form-currency) has also been\ndeprecated.", + "description": "The `currency_selector` filter must be applied to the [`form` object](/docs/api/liquid/objects/form) within a\n[currency form](/docs/api/liquid/tags/form#form-currency).", "parameters": [ { "description": "The desired `class` attribute.", @@ -1229,7 +1229,7 @@ }, { "name": "format", - "description": "Specify a locale-aware date format. You can use the following formats:\n\n- `abbreviated_date`\n- `basic`\n- `date`\n- `date_at_time`\n- `default`\n- `on_date`\n- `short` (deprecated)\n- `long` (deprecated)\n\n> Note:\n> You can also [define custom formats](/api/liquid/filters/date-setting-format-options-in-locale-files) in your theme's locale files.\n", + "description": "Specify a locale-aware date format. You can use the following formats:\n\n- `abbreviated_date`\n- `basic`\n- `date`\n- `date_at_time`\n- `default`\n- `on_date`\n- `short` (deprecated)\n- `long` (deprecated)\n\n> Note:\n> You can also [define custom formats](/docs/api/liquid/filters/date-setting-format-options-in-locale-files) in your theme's locale files.\n", "syntax": "string | date: format: string", "path": "/blogs/potion-notions/how-to-tell-if-you-have-run-out-of-invisibility-potion", "raw_liquid": "{{ article.created_at | date: format: 'abbreviated_date' }}", @@ -1305,7 +1305,7 @@ "category": "font", "deprecated": false, "deprecation_reason": "", - "description": "The `font_modify` filter requires two parameters. The first indicates which property should be modified and the second is\neither the new value, or modification amount, for that property.\n\n> Tip:\n> You can access every variant of the chosen font's family by using [`font.variants`](/api/liquid/objects/font#font-variants).\n> However, you can more easily access specific styles and weights by using the `font_modify` filter.\n\nThe following table outlines the valid font properties and modification values:\n\n<table>\n <thead>\n <th>Property</th>\n <th>Modification value</th>\n <th>Output</th>\n </thead>\n <tbody>\n <tr>\n <td rowspan=3><code>style</code></td>\n <td><code>normal</code></td>\n <td>Returns the normal variant of the same weight, if it exists.</td>\n </tr>\n <tr>\n <td><code>italic</code></td>\n <td>Returns the italic variant of the same weight, if it exists.</td>\n </tr>\n <tr>\n <td><code>oblique</code></td>\n <td>\n <p>Returns the oblique variant of the same weight, if it exists.</p>\n <p>Oblique variants are similar to italic variants in appearance. All Shopify fonts have only oblique or italic variants, not both.</p>\n </td>\n </tr>\n <tr>\n <td rowspan=7><code>weight</code></td>\n <td><code>100</code> &rarr; <code>900</code></td>\n <td>Returns a variant of the same style with the given weight, if it exists.</td>\n </tr>\n <tr>\n <td><code>normal</code></td>\n <td>Returns a variant of the same style with a weight of <code>400</code>, if it exists.</td>\n </tr>\n <tr>\n <td><code>bold</code></td>\n <td>Returns a variant of the same style with a weight of <code>700</code>, if it exists.</td>\n </tr>\n <tr>\n <td><code>+100</code> &rarr; <code>+900</code></td>\n <td>\n <p>Returns a variant of the same style with a weight incremented by the given value, if it exists.</p>\n <p>For example, if a font has a weight of <code>400</code>, then using <code>+100</code> would return the font with a weight of <code>500</code>.</p>\n </td>\n </tr>\n <tr>\n <td><code>-100</code> &rarr; <code>-900</code></td>\n <td>\n <p>Returns a variant of the same style with a weight decremented by the given value, if it exists.</p>\n <p>For example, if a font has a weight of <code>400</code>, then using <code>-100</code> would return the font with a weight of <code>300</code>.</p>\n </td>\n </tr>\n <tr>\n <td><code>lighter</code></td>\n <td>Returns a lighter variant of the same style by applying the rules used by the <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Meaning_of_relative_weights\">CSS <code>font-weight</code> property</a> and browser <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Fallback_weights\">fallback weights</a>, if it exists.</td>\n </tr>\n <tr>\n <td><code>bolder</code></td>\n <td>Returns a bolder variant of the same style by applying the rules used by the <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Meaning_of_relative_weights\">CSS <code>font-weight</code> property</a> and browser <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Fallback_weights\">fallback weights</a>, if it exists.</td>\n </tr>\n </tbody>\n</table>", + "description": "The `font_modify` filter requires two parameters. The first indicates which property should be modified and the second is\neither the new value, or modification amount, for that property.\n\n> Tip:\n> You can access every variant of the chosen font's family by using [`font.variants`](/docs/api/liquid/objects/font#font-variants).\n> However, you can more easily access specific styles and weights by using the `font_modify` filter.\n\nThe following table outlines the valid font properties and modification values:\n\n<table>\n <thead>\n <th>Property</th>\n <th>Modification value</th>\n <th>Output</th>\n </thead>\n <tbody>\n <tr>\n <td rowspan=3><code>style</code></td>\n <td><code>normal</code></td>\n <td>Returns the normal variant of the same weight, if it exists.</td>\n </tr>\n <tr>\n <td><code>italic</code></td>\n <td>Returns the italic variant of the same weight, if it exists.</td>\n </tr>\n <tr>\n <td><code>oblique</code></td>\n <td>\n <p>Returns the oblique variant of the same weight, if it exists.</p>\n <p>Oblique variants are similar to italic variants in appearance. All Shopify fonts have only oblique or italic variants, not both.</p>\n </td>\n </tr>\n <tr>\n <td rowspan=7><code>weight</code></td>\n <td><code>100</code> &rarr; <code>900</code></td>\n <td>Returns a variant of the same style with the given weight, if it exists.</td>\n </tr>\n <tr>\n <td><code>normal</code></td>\n <td>Returns a variant of the same style with a weight of <code>400</code>, if it exists.</td>\n </tr>\n <tr>\n <td><code>bold</code></td>\n <td>Returns a variant of the same style with a weight of <code>700</code>, if it exists.</td>\n </tr>\n <tr>\n <td><code>+100</code> &rarr; <code>+900</code></td>\n <td>\n <p>Returns a variant of the same style with a weight incremented by the given value, if it exists.</p>\n <p>For example, if a font has a weight of <code>400</code>, then using <code>+100</code> would return the font with a weight of <code>500</code>.</p>\n </td>\n </tr>\n <tr>\n <td><code>-100</code> &rarr; <code>-900</code></td>\n <td>\n <p>Returns a variant of the same style with a weight decremented by the given value, if it exists.</p>\n <p>For example, if a font has a weight of <code>400</code>, then using <code>-100</code> would return the font with a weight of <code>300</code>.</p>\n </td>\n </tr>\n <tr>\n <td><code>lighter</code></td>\n <td>Returns a lighter variant of the same style by applying the rules used by the <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Meaning_of_relative_weights\">CSS <code>font-weight</code> property</a> and browser <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Fallback_weights\">fallback weights</a>, if it exists.</td>\n </tr>\n <tr>\n <td><code>bolder</code></td>\n <td>Returns a bolder variant of the same style by applying the rules used by the <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Meaning_of_relative_weights\">CSS <code>font-weight</code> property</a> and browser <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight#Fallback_weights\">fallback weights</a>, if it exists.</td>\n </tr>\n </tbody>\n</table>", "parameters": [ { "description": "Font property to modify", @@ -1345,7 +1345,7 @@ }, { "name": "Non-existent font variants", - "description": "If the `font_modify` filter tries to create a font variant that doesn't exist, then it returns `nil`. To handle this, you can either assign a fallback value with the [`default` filter](/api/liquid/filters/default), or check for `nil` before using the variant.\n", + "description": "If the `font_modify` filter tries to create a font variant that doesn't exist, then it returns `nil`. To handle this, you can either assign a fallback value with the [`default` filter](/docs/api/liquid/filters/default), or check for `nil` before using the variant.\n", "syntax": "", "path": "/", "raw_liquid": "{%- assign bold_font = settings.type_body_font | font_modify: 'weight', 'bold' -%}\n{%- assign italic_font = settings.type_body_font | font_modify: 'style', 'italic' -%}\n{%- assign heavy_font = settings.type_body_font | font_modify: 'weight', '900' | default: bold_font -%}\n{%- assign oblique_font = settings.type_body_font | font_modify: 'style', 'oblique' | default: italic_font -%}\n\nh2 {\n font-style: {{ heavy_font.weight }};\n}\n\n.italic {\n {% if oblique_font -%}\n font-style: {{ oblique_font.style }};\n {%- else -%}\n font-style: {{ italic_font.style }};\n {%- endif %}\n}", @@ -1434,7 +1434,7 @@ "category": "payment", "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> You can't render dynamic checkout buttons through AJAX requests, including those through the\n> [Section Rendering API](/api/section-rendering). The dynamic checkout buttons are added by JavaScript included\n> by Shopify through the [`content_for_header`](/api/liquid/objects/content_for_header) object, which only runs on\n> the initial page load.", + "description": "> Note:\n> You can't render dynamic checkout buttons through AJAX requests, including those through the\n> [Section Rendering API](/api/section-rendering). The dynamic checkout buttons are added by JavaScript included\n> by Shopify through the [`content_for_header`](/docs/api/liquid/objects/content_for_header) object, which only runs on\n> the initial page load.", "parameters": [ ], @@ -1458,7 +1458,7 @@ "show_data_tab": true } ], - "summary": "Generates an HTML container to host [dynamic checkout buttons](https://help.shopify.com/manual/online-store/dynamic-checkout)\nfor a product. The `payment_button` filter must be used on the `form` object within a [product form](/api/liquid/tags/form#form-product).", + "summary": "Generates an HTML container to host [dynamic checkout buttons](https://help.shopify.com/manual/online-store/dynamic-checkout)\nfor a product. The `payment_button` filter must be used on the `form` object within a [product form](/docs/api/liquid/tags/form#form-product).", "syntax": "form | payment_button", "name": "payment_button" }, @@ -1466,7 +1466,7 @@ "category": "payment", "deprecated": false, "deprecation_reason": "", - "description": "The `payment_terms` filter must be used on the `form` object within a [product form](/api/liquid/tags/form#form-product) or\n[cart form](/api/liquid/tags/form#form-cart).\n\n```liquid\n{% form 'product', product %}\n {{ form | payment_terms }}\n{% endform %}\n```\n\n```liquid\n{% form 'cart', cart %}\n {{ form | payment_terms }}\n{% endform %}\n```", + "description": "The `payment_terms` filter must be used on the `form` object within a [product form](/docs/api/liquid/tags/form#form-product) or\n[cart form](/docs/api/liquid/tags/form#form-cart).\n\n```liquid\n{% form 'product', product %}\n {{ form | payment_terms }}\n{% endform %}\n```\n\n```liquid\n{% form 'cart', cart %}\n {{ form | payment_terms }}\n{% endform %}\n```", "parameters": [ ], @@ -1521,7 +1521,7 @@ }, { "name": "format", - "description": "Specify a locale-aware date format. Accepts the following values:\n\n- `abbreviated_date`\n- `basic`\n- `date`\n- `date_at_time`\n- `default`\n- `on_date`\n- `short` (deprecated)\n- `long` (deprecated)\n\n> Note:\n> You can also [define custom formats](/api/liquid/filters/date-setting-format-options-in-locale-files) in your theme's locale files.\n", + "description": "Specify a locale-aware date format. Accepts the following values:\n\n- `abbreviated_date`\n- `basic`\n- `date`\n- `date_at_time`\n- `default`\n- `on_date`\n- `short` (deprecated)\n- `long` (deprecated)\n\n> Note:\n> You can also [define custom formats](/docs/api/liquid/filters/date-setting-format-options-in-locale-files) in your theme's locale files.\n", "syntax": "string | time_tag: format: string", "path": "/blogs/potion-notions/how-to-tell-if-you-have-run-out-of-invisibility-potion", "raw_liquid": "{{ article.created_at | time_tag: format: 'abbreviated_date' }}", @@ -1600,7 +1600,7 @@ "category": "format", "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> When using the JSON output in JavaScript, you don't need to wrap it in quotes because the `json` filter includes them.\n> The `json` filter also escapes any quotes inside the output.\n\n#### Product inventory\n\nWhen applied to a [`product` object](/api/liquid/objects/product) on any Shopify store created after December 5, 2017, the\n`json` filter doesn't output values for the `inventory_quantity` and `inventory_policy` properties of any associated\n[variants](/api/liquid/objects/variant). These properties are excluded to help prevent bots and crawlers from retrieving\ninventory quantities for stores to which they aren't granted access.\n\nIf you need inventory information, you can access it through individual variants.", + "description": "> Tip:\n> When using the JSON output in JavaScript, you don't need to wrap it in quotes because the `json` filter includes them.\n> The `json` filter also escapes any quotes inside the output.\n\n#### Product inventory\n\nWhen applied to a [`product` object](/docs/api/liquid/objects/product) on any Shopify store created after December 5, 2017, the\n`json` filter doesn't output values for the `inventory_quantity` and `inventory_policy` properties of any associated\n[variants](/docs/api/liquid/objects/variant). These properties are excluded to help prevent bots and crawlers from retrieving\ninventory quantities for stores to which they aren't granted access.\n\nIf you need inventory information, you can access it through individual variants.", "parameters": [ ], @@ -1984,7 +1984,7 @@ "category": "array", "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> The `concat` filter won't filter out duplicates. If you want to remove duplicates, then you need to use the\n> [`uniq` filter](/api/liquid/filters/uniq).", + "description": "> Note:\n> The `concat` filter won't filter out duplicates. If you want to remove duplicates, then you need to use the\n> [`uniq` filter](/docs/api/liquid/filters/uniq).", "parameters": [ ], @@ -2057,7 +2057,7 @@ "show_data_tab": true } ], - "summary": "Sets a default value for any variable whose value is one of the following:\n\n- [`empty`](/api/liquid/basics#empty)\n- [`false`](/api/liquid/basics#truthy-and-falsy)\n- [`nil`](/api/liquid/basics#nil)", + "summary": "Sets a default value for any variable whose value is one of the following:\n\n- [`empty`](/docs/api/liquid/basics#empty)\n- [`false`](/docs/api/liquid/basics#truthy-and-falsy)\n- [`nil`](/docs/api/liquid/basics#nil)", "syntax": "variable | default: variable", "name": "default" }, @@ -2792,7 +2792,7 @@ }, { "name": "Reversing strings", - "description": "You can't use the `reverse` filter on strings directly. However, you can use the [`split` filter](/api/liquid/filters/split) to create an array of characters in the string, reverse that array, and then use the [`join` filter](/api/liquid/filters/join) to combine them again.\n", + "description": "You can't use the `reverse` filter on strings directly. However, you can use the [`split` filter](/docs/api/liquid/filters/split) to create an array of characters in the string, reverse that array, and then use the [`join` filter](/docs/api/liquid/filters/join) to combine them again.\n", "syntax": "", "path": "/collections/sale-potions", "raw_liquid": "{{ collection.title | split: '' | reverse | join: '' }}", @@ -3499,7 +3499,7 @@ "show_data_tab": false } ], - "summary": "Generates an HTML `<iframe>` tag containing the player for a given external video. The input for the `external_video_tag`\nfilter can be either a [`media` object](/api/liquid/objects/media) or [`external_video_url`](/api/liquid/filters/external_video_url).", + "summary": "Generates an HTML `<iframe>` tag containing the player for a given external video. The input for the `external_video_tag`\nfilter can be either a [`media` object](/docs/api/liquid/objects/media) or [`external_video_url`](/docs/api/liquid/filters/external_video_url).", "syntax": "variable | external_video_tag", "name": "external_video_tag" }, @@ -3531,7 +3531,7 @@ "show_data_tab": false } ], - "summary": "Returns the URL for a given external video. Use this filter to specify parameters for the external video player generated\nby the [`external_video_tag` filter](/api/liquid/filters/external_video_tag).", + "summary": "Returns the URL for a given external video. Use this filter to specify parameters for the external video player generated\nby the [`external_video_tag` filter](/docs/api/liquid/filters/external_video_tag).", "syntax": "media | external_video_url: attribute: string", "name": "external_video_url" }, @@ -3539,7 +3539,7 @@ "category": "media", "deprecated": false, "deprecation_reason": "", - "description": "By default, `width` and `height` attributes are added to the `<img>` tag based on the dimensions and aspect ratio from\nthe image URL. However, you can override these attributes with the [width](/api/liquid/filters/image_tag#image_tag-width) and [height](/api/liquid/filters/image_tag#image_tag-height)\nparameters. If only one parameter is provided, then only that attribute is added.\n\n> Note:\n> This filter automatically applies the `object-position` css style from the focal point value if set. For more\n> information, refer to the [`focal_point` object](/api/liquid/objects/focal_point).", + "description": "By default, `width` and `height` attributes are added to the `<img>` tag based on the dimensions and aspect ratio from\nthe image URL. However, you can override these attributes with the [width](/docs/api/liquid/filters/image_tag#image_tag-width) and [height](/docs/api/liquid/filters/image_tag#image_tag-height)\nparameters. If only one parameter is provided, then only that attribute is added.\n\n> Note:\n> This filter automatically applies the `object-position` css style from the focal point value if set. For more\n> information, refer to the [`focal_point` object](/docs/api/liquid/objects/focal_point).", "parameters": [ { "description": "The width of the image.", @@ -3659,7 +3659,7 @@ }, { "name": "srcset", - "description": "By default, Shopify generates a `srcset`. However, you can create your own `srcset`.\nThe `srcset` parameter takes precedence over the [`width` parameter](/api/liquid/filters/image_tag#image_tag-width).\nYou shouldn't to use the `srcset` parameter unless you want to remove the attribute by setting the parameter to `nil`.\n", + "description": "By default, Shopify generates a `srcset`. However, you can create your own `srcset`.\nThe `srcset` parameter takes precedence over the [`width` parameter](/docs/api/liquid/filters/image_tag#image_tag-width).\nYou shouldn't to use the `srcset` parameter unless you want to remove the attribute by setting the parameter to `nil`.\n", "syntax": "image_url | image_tag: srcset: string", "path": "/products/health-potion", "raw_liquid": "{{ product | image_url: width: 200 | image_tag: srcset: nil }}", @@ -3698,7 +3698,7 @@ "show_data_tab": true } ], - "summary": "Generates an HTML `<img>` tag for a given [`image_url`](/api/liquid/filters/image_url).", + "summary": "Generates an HTML `<img>` tag for a given [`image_url`](/docs/api/liquid/filters/image_url).", "syntax": "string | image_tag", "name": "image_tag" }, @@ -3814,7 +3814,7 @@ "category": "media", "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> When `mp4` videos are uploaded, Shopify generates an `m3u8` file as an additional [`video_source`](/api/liquid/objects/video_source).\n> An `m3u8` file enables video players to leverage [HTTP live streaming (HLS)](https://developer.apple.com/streaming/),\n> resulting in an optimized video experience based on the user's internet connection. If loop is enabled, the HLS source is not used\n> in order to allow progessive download to cache the video.\n>\n> If the `m3u8` source isn't supported, then the player falls back to the `mp4` source.", + "description": "> Note:\n> When `mp4` videos are uploaded, Shopify generates an `m3u8` file as an additional [`video_source`](/docs/api/liquid/objects/video_source).\n> An `m3u8` file enables video players to leverage [HTTP live streaming (HLS)](https://developer.apple.com/streaming/),\n> resulting in an optimized video experience based on the user's internet connection. If loop is enabled, the HLS source is not used\n> in order to allow progessive download to cache the video.\n>\n> If the `m3u8` source isn't supported, then the player falls back to the `mp4` source.", "parameters": [ { "description": "The dimensions of the video's poster image.", @@ -3898,7 +3898,7 @@ }, { "name": "Complex types", - "description": "\nThe following metafield types return nested elements, or different elements depending on the metafield contents:\n\n- [`dimension`](/api/liquid/filters/metafield_tag#metafield_tag-dimension)\n- [`file_reference`](/api/liquid/filters/metafield_tag#metafield_tag-file_reference)\n- [`list.single_line_text_field`](/api/liquid/filters/metafield_tag#metafield_tag-list.single_line_text_field)\n- [`volume`](/api/liquid/filters/metafield_tag#metafield_tag-volume)\n- [`weight`](/api/liquid/filters/metafield_tag#metafield_tag-weight)", + "description": "\nThe following metafield types return nested elements, or different elements depending on the metafield contents:\n\n- [`dimension`](/docs/api/liquid/filters/metafield_tag#metafield_tag-dimension)\n- [`file_reference`](/docs/api/liquid/filters/metafield_tag#metafield_tag-file_reference)\n- [`list.single_line_text_field`](/docs/api/liquid/filters/metafield_tag#metafield_tag-list.single_line_text_field)\n- [`volume`](/docs/api/liquid/filters/metafield_tag#metafield_tag-volume)\n- [`weight`](/docs/api/liquid/filters/metafield_tag#metafield_tag-weight)", "syntax": "", "path": "/products/health-potion", "raw_liquid": "", @@ -3918,7 +3918,7 @@ }, { "name": "file_reference", - "description": "The output varies depending on the type of file. There are the following categories of file type:\n\n| File type | Description |\n| --- | --- |\n| Image | Images in the format of `jpg`, `png`, `gif`, `heic`, and `webp`. |\n| Video | Videos in the format of `mov`, and `mp4`. |\n| Other | Any other file type. |\n\n##### Image\n\nOutputs an `<img>` element with the following attributes:\n\n| Attribute | Value |\n| --- | --- |\n| `src` | The image's URL. |\n| `alt` | The image's alt text. |\n| `class` | `metafield-file_reference` |\n\n##### Video\n\nOutputs a `<video>` element with the following attributes:\n\n| Attribute | Value |\n| --- | --- |\n| `src` | The video's URL. |\n| `poster` | The video's preview image (poster) URL. |\n| `playsinline` | N/A - Indicates the video will be played \"inline\" within the element's playback area. |\n| `preload` | `metadata` - Only metadata is pre-fetched before the video is played. |\n\nThe `<video>` element contains the following child elements:\n\n| Child element | HTML element | Attributes |\n| --- | --- | --- |\n| The video's multimedia playlist source, for [HTTP live streaming (HLS)](https://developer.apple.com/streaming/) | `<source>` | `src=\"<the video's m3u8 source URL>\"`<br><br>`type=\"application/x-mpegURL\"` |\n| The video's original source | `<source>` | `src=\"<the video's source URL>\"`<br><br>`type=\"<the video's original source MIME type>\"` |\n| The video's preview (poster) image | `<img>` | `src=\"<the video's preview image URL>\"` |\n\n##### Other\n\nOutputs an `<a>` element with a link to the file and the following attribute:\n\n| Attribute | Value |\n| --- | --- |\n| `class` | `metafield-file_reference` |\n\nThe `<a>` element contains an `<img>` element for the file's [preview image](/api/liquid/objects/generic_file#generic_file-preview_image) with the following attributes:\n\n| Attribute | Value |\n| --- | --- |\n| `src` | The file's preview image URL. |\n| `loading` | `lazy` - The image isn't loaded until it's almost in view. |\n", + "description": "The output varies depending on the type of file. There are the following categories of file type:\n\n| File type | Description |\n| --- | --- |\n| Image | Images in the format of `jpg`, `png`, `gif`, `heic`, and `webp`. |\n| Video | Videos in the format of `mov`, and `mp4`. |\n| Other | Any other file type. |\n\n##### Image\n\nOutputs an `<img>` element with the following attributes:\n\n| Attribute | Value |\n| --- | --- |\n| `src` | The image's URL. |\n| `alt` | The image's alt text. |\n| `class` | `metafield-file_reference` |\n\n##### Video\n\nOutputs a `<video>` element with the following attributes:\n\n| Attribute | Value |\n| --- | --- |\n| `src` | The video's URL. |\n| `poster` | The video's preview image (poster) URL. |\n| `playsinline` | N/A - Indicates the video will be played \"inline\" within the element's playback area. |\n| `preload` | `metadata` - Only metadata is pre-fetched before the video is played. |\n\nThe `<video>` element contains the following child elements:\n\n| Child element | HTML element | Attributes |\n| --- | --- | --- |\n| The video's multimedia playlist source, for [HTTP live streaming (HLS)](https://developer.apple.com/streaming/) | `<source>` | `src=\"<the video's m3u8 source URL>\"`<br><br>`type=\"application/x-mpegURL\"` |\n| The video's original source | `<source>` | `src=\"<the video's source URL>\"`<br><br>`type=\"<the video's original source MIME type>\"` |\n| The video's preview (poster) image | `<img>` | `src=\"<the video's preview image URL>\"` |\n\n##### Other\n\nOutputs an `<a>` element with a link to the file and the following attribute:\n\n| Attribute | Value |\n| --- | --- |\n| `class` | `metafield-file_reference` |\n\nThe `<a>` element contains an `<img>` element for the file's [preview image](/docs/api/liquid/objects/generic_file#generic_file-preview_image) with the following attributes:\n\n| Attribute | Value |\n| --- | --- |\n| `src` | The file's preview image URL. |\n| `loading` | `lazy` - The image isn't loaded until it's almost in view. |\n", "syntax": "", "path": "/products/health-potion", "raw_liquid": "<!-- Image -->\n{{ product.metafields.information.promo_image | metafield_tag }}\n\n<!-- Video -->\n{{ product.metafields.information.promo_video | metafield_tag }}\n\n<!-- Other -->\n{{ product.metafields.information.disclaimers | metafield_tag }}", @@ -4117,7 +4117,7 @@ "show_data_tab": true } ], - "summary": "Formats a given price based on the store's [**HTML without currency** setting](https://help.shopify.com/manual/payments/currency-formatting), excluding the decimal separator\n(either `.` or `,`) and trailing zeros.\n\nIf the price has a non-zero decimal value, then the output is the same as the [`money` filter](/api/liquid/filters#money).", + "summary": "Formats a given price based on the store's [**HTML without currency** setting](https://help.shopify.com/manual/payments/currency-formatting), excluding the decimal separator\n(either `.` or `,`) and trailing zeros.\n\nIf the price has a non-zero decimal value, then the output is the same as the [`money` filter](/docs/api/liquid/filters#money).", "syntax": "number | money_without_trailing_zeros", "name": "money_without_trailing_zeros" }, @@ -4149,7 +4149,7 @@ "show_data_tab": true } ], - "summary": "Generates HTML for a set of links for paginated results. Must be applied to the [`paginate` object](/api/liquid/objects/paginate).", + "summary": "Generates HTML for a set of links for paginated results. Must be applied to the [`paginate` object](/docs/api/liquid/objects/paginate).", "syntax": "paginate | default_pagination", "name": "default_pagination" }, @@ -4157,7 +4157,7 @@ "category": "customer", "deprecated": false, "deprecation_reason": "", - "description": "Configure the storefront for Follow on Shop. [Learn more](https://help.shopify.com/manual/online-store/themes/customizing-themes/follow-on-shop)\n\n> Note:\n> The presence of the [Shop](/api/liquid/objects/shop) object\n> is required for validation purposes only.\n\n> Note:\n> The `action` specified is always `'follow'`. If this parameter is not supplied the button will not render.\n\n```liquid\n{{ shop | login_button: action: 'follow' }}\n```", + "description": "Configure the storefront for Follow on Shop. [Learn more](https://help.shopify.com/manual/online-store/themes/customizing-themes/follow-on-shop)\n\n> Note:\n> The presence of the [Shop](/docs/api/liquid/objects/shop) object\n> is required for validation purposes only.\n\n> Note:\n> The `action` specified is always `'follow'`. If this parameter is not supplied the button will not render.\n\n```liquid\n{{ shop | login_button: action: 'follow' }}\n```", "parameters": [ { "description": "Specify 'follow' for the follow flow.", @@ -4243,7 +4243,7 @@ "show_data_tab": true } ], - "summary": "Converts a string into a [handle](/api/liquid/basics#handles).", + "summary": "Converts a string into a [handle](/docs/api/liquid/basics#handles).", "syntax": "string | handleize", "name": "handleize" }, @@ -4283,7 +4283,7 @@ "category": "string", "deprecated": false, "deprecation_reason": "", - "description": "The `url_param_escape` filter escapes the same characters as [`url_escape`](/api/liquid/filters/url_escape), with the\naddition of `&`.", + "description": "The `url_param_escape` filter escapes the same characters as [`url_escape`](/docs/api/liquid/filters/url_escape), with the\naddition of `&`.", "parameters": [ ], @@ -4555,7 +4555,7 @@ { "category": "media", "deprecated": true, - "deprecation_reason": "The `article_img_url` filter has been replaced by [`image_url`](/api/liquid/filters/image_url).", + "deprecation_reason": "The `article_img_url` filter has been replaced by [`image_url`](/docs/api/liquid/filters/image_url).", "description": "", "parameters": [ { @@ -4588,7 +4588,7 @@ }, { "name": "size", - "description": "By default, the `article_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/api/liquid/filters/img_url#img_url-size).\n", + "description": "By default, the `article_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/docs/api/liquid/filters/img_url#img_url-size).\n", "syntax": "image | article_img_url: string", "path": "/blogs/potion-notions/how-to-tell-if-you-have-run-out-of-invisibility-potion", "raw_liquid": "{{ article.image | article_img_url: 'large' }}", @@ -4597,7 +4597,7 @@ "show_data_tab": true } ], - "summary": "Returns the [CDN URL](/themes/best-practices/performance/platform#shopify-cdn) for an [article's image](/api/liquid/objects/article#article-image).", + "summary": "Returns the [CDN URL](/themes/best-practices/performance/platform#shopify-cdn) for an [article's image](/docs/api/liquid/objects/article#article-image).", "syntax": "variable | article_img_url", "name": "article_img_url" }, @@ -4637,7 +4637,7 @@ }, { "name": "size", - "description": "By default, the `asset_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/api/liquid/filters/img_url#img_url-size).\n", + "description": "By default, the `asset_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/docs/api/liquid/filters/img_url#img_url-size).\n", "syntax": "image | asset_img_url: string", "path": "/", "raw_liquid": "{{ 'red-and-black-bramble-berries.jpg' | asset_img_url: 'large' }}", @@ -4685,7 +4685,7 @@ { "category": "media", "deprecated": true, - "deprecation_reason": "The `collection_img_url` filter has been replaced by [`image_url`](/api/liquid/filters/image_url).", + "deprecation_reason": "The `collection_img_url` filter has been replaced by [`image_url`](/docs/api/liquid/filters/image_url).", "description": "", "parameters": [ { @@ -4718,7 +4718,7 @@ }, { "name": "The size parameter", - "description": "By default, the `collection_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/api/liquid/filters/img_url#img_url-size).\n", + "description": "By default, the `collection_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/docs/api/liquid/filters/img_url#img_url-size).\n", "syntax": "image | collection_img_url: string", "path": "/collections/sale-potions", "raw_liquid": "{{ collection.image | collection_img_url: 'large' }}", @@ -4727,7 +4727,7 @@ "show_data_tab": true } ], - "summary": "Returns the [CDN URL](/themes/best-practices/performance/platform#shopify-cdn) for a [collection's image](/api/liquid/objects/collection#collection-image).", + "summary": "Returns the [CDN URL](/themes/best-practices/performance/platform#shopify-cdn) for a [collection's image](/docs/api/liquid/objects/collection#collection-image).", "syntax": "variable | collection_img_url", "name": "collection_img_url" }, @@ -4767,7 +4767,7 @@ }, { "name": "The size parameter", - "description": "By default, the `file_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/api/liquid/filters/img_url#img_url-size).\n", + "description": "By default, the `file_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/docs/api/liquid/filters/img_url#img_url-size).\n", "syntax": "image | file_img_url: string", "path": "/", "raw_liquid": "{{ 'potions-header.png' | file_img_url: 'large' }}", @@ -4823,7 +4823,7 @@ "category": "hosted_file", "deprecated": false, "deprecation_reason": "", - "description": "Global assets are kept in a directory on Shopify's server. Using global assets can be faster than loading the resource\ndirectly.\n\nDepending on the resource type, you might need to use an additional filter to load the resource. The following table\noutlines which filter to use for specific resource types.\n\n| Resource type | Additional filter |\n| --- | --- |\n| JavaScript (`.js`) | [`script_tag`](/api/liquid/filters/script_tag) |\n| CSS (`.css`) | [`stylesheet_tag`](/api/liquid/filters/stylesheet_tag) |\n\nThe following table outlines the available global assets:\n\n| Category | Assets |\n| --- | --- |\n| Firebug | - `firebug/firebug.css`<br>- `firebug/firebug.html`<br>- `firebug/firebug.js`<br>- `firebug/firebugx.js`<br>- `firebug/errorIcon.png`<br>- `firebug/infoIcon.png`<br>- `firebug/warningIcon.png` |\n| JavaScript libraries | - `controls.js`<br>- `dragdrop.js`<br>- `effects.js`<br>- `ga.js`<br>- `mootools.js` |\n| Lightbox | - `lightbox.css`<br>- `lightbox.js`<br><br>- `lightbox/v1/lightbox.css`<br>- `lightbox/v1/lightbox.js`<br><br>- `lightbox/v2/lightbox.css`<br>- `lightbox/v2/lightbox.js`<br>- `lightbox/v2/close.gif`<br>- `lightbox/v2/loading.gif`<br>- `lightbox/v2/overlay.png`<br>- `lightbox/v2/zoom-lg.gif`<br><br>- `lightbox/v204/lightbox.css`<br>- `lightbox/v204/lightbox.js`<br>- `lightbox/v204/bullet.gif`<br>- `lightbox/v204/close.gif`<br>- `lightbox/v204/closelabel.gif`<br>- `lightbox/v204/donatebutton.gif`<br>- `lightbox/v204/downloadicon.gif`<br>- `lightbox/v204/loading.gif`<br>- `lightbox/v204/nextlabel.png`<br>- `lightbox/v204/prevlabel.gif` |\n| Prototype | - `prototype.js`<br>- `prototype/1.5/prototype.js`<br>- `prototype/1.6/prototype.js` |\n| script.aculo.us | - `scriptaculous/1.8.2/scriptaculous.js`<br>- `scriptaculous/1.8.2/builder.js`<br>- `scriptaculous/1.8.2/controls.js`<br>- `scriptaculous/1.8.2/dragdrop.js`<br>- `scriptaculous/1.8.2/effects.js`<br>- `scriptaculous/1.8.2/slider.js`<br>- `scriptaculous/1.8.2/sound.js`<br>- `scriptaculous/1.8.2/unittest.js` |\n| Shopify | - `list-collection.css`<br>- `textile.css` |", + "description": "Global assets are kept in a directory on Shopify's server. Using global assets can be faster than loading the resource\ndirectly.\n\nDepending on the resource type, you might need to use an additional filter to load the resource. The following table\noutlines which filter to use for specific resource types.\n\n| Resource type | Additional filter |\n| --- | --- |\n| JavaScript (`.js`) | [`script_tag`](/docs/api/liquid/filters/script_tag) |\n| CSS (`.css`) | [`stylesheet_tag`](/docs/api/liquid/filters/stylesheet_tag) |\n\nThe following table outlines the available global assets:\n\n| Category | Assets |\n| --- | --- |\n| Firebug | - `firebug/firebug.css`<br>- `firebug/firebug.html`<br>- `firebug/firebug.js`<br>- `firebug/firebugx.js`<br>- `firebug/errorIcon.png`<br>- `firebug/infoIcon.png`<br>- `firebug/warningIcon.png` |\n| JavaScript libraries | - `controls.js`<br>- `dragdrop.js`<br>- `effects.js`<br>- `ga.js`<br>- `mootools.js` |\n| Lightbox | - `lightbox.css`<br>- `lightbox.js`<br><br>- `lightbox/v1/lightbox.css`<br>- `lightbox/v1/lightbox.js`<br><br>- `lightbox/v2/lightbox.css`<br>- `lightbox/v2/lightbox.js`<br>- `lightbox/v2/close.gif`<br>- `lightbox/v2/loading.gif`<br>- `lightbox/v2/overlay.png`<br>- `lightbox/v2/zoom-lg.gif`<br><br>- `lightbox/v204/lightbox.css`<br>- `lightbox/v204/lightbox.js`<br>- `lightbox/v204/bullet.gif`<br>- `lightbox/v204/close.gif`<br>- `lightbox/v204/closelabel.gif`<br>- `lightbox/v204/donatebutton.gif`<br>- `lightbox/v204/downloadicon.gif`<br>- `lightbox/v204/loading.gif`<br>- `lightbox/v204/nextlabel.png`<br>- `lightbox/v204/prevlabel.gif` |\n| Prototype | - `prototype.js`<br>- `prototype/1.5/prototype.js`<br>- `prototype/1.6/prototype.js` |\n| script.aculo.us | - `scriptaculous/1.8.2/scriptaculous.js`<br>- `scriptaculous/1.8.2/builder.js`<br>- `scriptaculous/1.8.2/controls.js`<br>- `scriptaculous/1.8.2/dragdrop.js`<br>- `scriptaculous/1.8.2/effects.js`<br>- `scriptaculous/1.8.2/slider.js`<br>- `scriptaculous/1.8.2/sound.js`<br>- `scriptaculous/1.8.2/unittest.js` |\n| Shopify | - `list-collection.css`<br>- `textile.css` |", "parameters": [ ], @@ -4855,7 +4855,7 @@ "category": "media", "deprecated": false, "deprecation_reason": "", - "description": "You can use the `image_url` filter on the following objects, as well as their `src` property:\n\n- [`article`](/api/liquid/objects/article)\n- [`collection`](/api/liquid/objects/collection)\n- [`image`](/api/liquid/objects/image)\n- [`line_item`](/api/liquid/objects/line_item)\n- [`product`](/api/liquid/objects/product)\n- [`variant`](/api/liquid/objects/variant)\n\n> Caution:\n> You need to specify either a [`width`](/api/liquid/filters/image_url#image_url-width) or\n> [`height`](/api/liquid/filters/image_url#image_url-height) parameter. If neither are specified, then an error is returned.\n\n> Note:\n> Regardless of the specified dimensions, an image can never be resized to be larger than its original dimensions.", + "description": "You can use the `image_url` filter on the following objects, as well as their `src` property:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`image`](/docs/api/liquid/objects/image)\n- [`line_item`](/docs/api/liquid/objects/line_item)\n- [`product`](/docs/api/liquid/objects/product)\n- [`variant`](/docs/api/liquid/objects/variant)\n\n> Caution:\n> You need to specify either a [`width`](/docs/api/liquid/filters/image_url#image_url-width) or\n> [`height`](/docs/api/liquid/filters/image_url#image_url-height) parameter. If neither are specified, then an error is returned.\n\n> Note:\n> Regardless of the specified dimensions, an image can never be resized to be larger than its original dimensions.", "parameters": [ { "description": "How the image should be cropped to match the desired dimensions.", @@ -4975,8 +4975,8 @@ { "category": "media", "deprecated": true, - "deprecation_reason": "The `img_tag` filter has been replaced by [`image_tag`](/api/liquid/filters/image_tag).", - "description": "You can also use the `img_tag` filter on the following objects:\n\n- [`article`](/api/liquid/objects/article)\n- [`collection`](/api/liquid/objects/collection)\n- [`image`](/api/liquid/objects/image)\n- [`line_item`](/api/liquid/objects/line_item)\n- [`product`](/api/liquid/objects/product)\n- [`variant`](/api/liquid/objects/variant)", + "deprecation_reason": "The `img_tag` filter has been replaced by [`image_tag`](/docs/api/liquid/filters/image_tag).", + "description": "You can also use the `img_tag` filter on the following objects:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`image`](/docs/api/liquid/objects/image)\n- [`line_item`](/docs/api/liquid/objects/line_item)\n- [`product`](/docs/api/liquid/objects/product)\n- [`variant`](/docs/api/liquid/objects/variant)", "parameters": [ { "description": "The image's alt text.", @@ -5024,7 +5024,7 @@ }, { "name": "Optional parameters", - "description": "The `img_tag` filter accepts 3 unnamed parameters, separated by commas, to specify the `alt` and `class` attributes, and the\n[size](/api/liquid/filters/img_url#img_url-size) of the image. Because the parameters are read in that order, you must include a value for each parameter before the last\nparameter you want to specify. If you don't want to include a parameter that precedes one that you do want to include, then\nyou can set the value to an empty string.\n\n> Note:\n> The `size` attribute of the `img_tag` filter can't be used in conjunction with the [`img_url` filter](/api/liquid/filters/img_url).\n> If both are used, then the `img_url` filter will override the `size` parameter of the `img_tag` filter.\n", + "description": "The `img_tag` filter accepts 3 unnamed parameters, separated by commas, to specify the `alt` and `class` attributes, and the\n[size](/docs/api/liquid/filters/img_url#img_url-size) of the image. Because the parameters are read in that order, you must include a value for each parameter before the last\nparameter you want to specify. If you don't want to include a parameter that precedes one that you do want to include, then\nyou can set the value to an empty string.\n\n> Note:\n> The `size` attribute of the `img_tag` filter can't be used in conjunction with the [`img_url` filter](/docs/api/liquid/filters/img_url).\n> If both are used, then the `img_url` filter will override the `size` parameter of the `img_tag` filter.\n", "syntax": "variable | img_tag: string, string, string", "path": "/products/health-potion", "raw_liquid": "{{ product | img_tag: 'image alt text', '', '450x450' }}", @@ -5040,8 +5040,8 @@ { "category": "media", "deprecated": true, - "deprecation_reason": "The `img_url` filter has been replaced by [`image_url`](/api/liquid/filters/image_url).", - "description": "You can use the `img_url` filter on the following objects:\n\n- [`article`](/api/liquid/objects/article)\n- [`collection`](/api/liquid/objects/collection)\n- [`image`](/api/liquid/objects/image)\n- [`line_item`](/api/liquid/objects/line_item)\n- [`product`](/api/liquid/objects/product)\n- [`variant`](/api/liquid/objects/variant)", + "deprecation_reason": "The `img_url` filter has been replaced by [`image_url`](/docs/api/liquid/filters/image_url).", + "description": "You can use the `img_url` filter on the following objects:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`image`](/docs/api/liquid/objects/image)\n- [`line_item`](/docs/api/liquid/objects/line_item)\n- [`product`](/docs/api/liquid/objects/product)\n- [`variant`](/docs/api/liquid/objects/variant)", "parameters": [ { "description": "The desired image size.", @@ -5217,7 +5217,7 @@ "show_data_tab": true } ], - "summary": "Returns the URL for an SVG image of a given [payment type](/api/liquid/objects/shop#shop-enabled_payment_types).", + "summary": "Returns the URL for an SVG image of a given [payment type](/docs/api/liquid/objects/shop#shop-enabled_payment_types).", "syntax": "type | payment_type_img_url", "name": "payment_type_img_url" }, @@ -5266,7 +5266,7 @@ "show_data_tab": true } ], - "summary": "Generates an HTML `<svg>` tag for a given [payment type](/api/liquid/objects/shop#shop-enabled_payment_types).", + "summary": "Generates an HTML `<svg>` tag for a given [payment type](/docs/api/liquid/objects/shop#shop-enabled_payment_types).", "syntax": "type | payment_type_svg_tag", "name": "payment_type_svg_tag" }, @@ -5323,7 +5323,7 @@ "category": "html", "deprecated": false, "deprecation_reason": "", - "description": "You should use this filter sparingly. For example, consider preloading only resources necessary for rendering\nabove-the-fold content. To learn more about preloading resources, refer to\n[Performance best practices for Shopify themes](/themes/best-practices/performance#preload-key-resources-defer-or-avoid-loading-others).\n\n> Tip:\n> If you want to preload a stylesheet, then use [`stylesheet_tag`](/api/liquid/filters/stylesheet_tag). If you want to\n> preload an image, then use [`image_tag`](/api/liquid/filters/image_tag).\n\nThe input to this filter must be a URL from one of the following filters:\n\n- [`asset_url`](/api/liquid/filters/asset_url)\n- [`global_asset_url`](/api/liquid/filters/global_asset_url)\n- [`shopify_asset_url`](/api/liquid/filters/shopify_asset_url)\n\nThe `preload_tag` filter also requires an [`as` parameter](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link#attr-as)\nbased on the kind of resource being preloaded.", + "description": "You should use this filter sparingly. For example, consider preloading only resources necessary for rendering\nabove-the-fold content. To learn more about preloading resources, refer to\n[Performance best practices for Shopify themes](/themes/best-practices/performance#preload-key-resources-defer-or-avoid-loading-others).\n\n> Tip:\n> If you want to preload a stylesheet, then use [`stylesheet_tag`](/docs/api/liquid/filters/stylesheet_tag). If you want to\n> preload an image, then use [`image_tag`](/docs/api/liquid/filters/image_tag).\n\nThe input to this filter must be a URL from one of the following filters:\n\n- [`asset_url`](/docs/api/liquid/filters/asset_url)\n- [`global_asset_url`](/docs/api/liquid/filters/global_asset_url)\n- [`shopify_asset_url`](/docs/api/liquid/filters/shopify_asset_url)\n\nThe `preload_tag` filter also requires an [`as` parameter](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link#attr-as)\nbased on the kind of resource being preloaded.", "parameters": [ { "description": "The type of element or resource to preload.", @@ -5371,7 +5371,7 @@ { "category": "media", "deprecated": true, - "deprecation_reason": "The `product_img_url` filter has been replaced by [`image_url`](/api/liquid/filters/image_url).", + "deprecation_reason": "The `product_img_url` filter has been replaced by [`image_url`](/docs/api/liquid/filters/image_url).", "description": "This can be the product's `featured_image` or any image from the `images` array.", "parameters": [ { @@ -5404,7 +5404,7 @@ }, { "name": "The size parameter", - "description": "By default, the `product_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/api/liquid/filters/img_url#img_url-size).\n", + "description": "By default, the `product_img_url` filter returns the `small` version of the image (100 x 100 px). However, you can specify a [size](/docs/api/liquid/filters/img_url#img_url-size).\n", "syntax": "image | product_img_url: string", "path": "/products/health-potion", "raw_liquid": "{{ product.images[0] | product_img_url: 'large' }}", @@ -5413,7 +5413,7 @@ "show_data_tab": true } ], - "summary": "Returns the [CDN URL](/themes/best-practices/performance/platform#shopify-cdn) for a [product image](/api/liquid/objects/product).", + "summary": "Returns the [CDN URL](/themes/best-practices/performance/platform#shopify-cdn) for a [product image](/docs/api/liquid/objects/product).", "syntax": "variable | product_img_url", "name": "product_img_url" }, @@ -5583,8 +5583,8 @@ "show_data_tab": true } ], - "summary": "Generates a formatted weight for a [`variant` object](/api/liquid/objects/variant#variant-weight). The weight unit is\nset in the [general settings](https://www.shopify.com/admin/settings/general) in the Shopify admin.", + "summary": "Generates a formatted weight for a [`variant` object](/docs/api/liquid/objects/variant#variant-weight). The weight unit is\nset in the [general settings](https://www.shopify.com/admin/settings/general) in the Shopify admin.", "syntax": "number | weight_with_unit", "name": "weight_with_unit" } -] \ No newline at end of file +] diff --git a/data/objects.json b/data/objects.json index 8c41d87..6cf54bb 100644 --- a/data/objects.json +++ b/data/objects.json @@ -22,7 +22,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "The `media` object can be returned by the [`product.media` array](/api/liquid/objects/product#product-media) or a\n[`file_reference` metafield](/apps/metafields/types).\n\nYou can use [media filters](/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](/themes/product-merchandising/media/support-media).\n\n> Note:\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.", + "description": "The `media` object can be returned by the [`product.media` array](/docs/api/liquid/objects/product#product-media) or a\n[`file_reference` metafield](/apps/metafields/types).\n\nYou can use [media filters](/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](/themes/product-merchandising/media/support-media).\n\n> Note:\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.", "properties": [ { "deprecated": false, @@ -57,7 +57,7 @@ "array_value": "" } ], - "summary": "The position of the media in the [`product.media` array](/api/liquid/objects/product#product-media).", + "summary": "The position of the media in the [`product.media` array](/docs/api/liquid/objects/product#product-media).", "name": "position" }, { @@ -67,7 +67,7 @@ "examples": [ { "name": "Filter for media of a specific type", - "description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n", + "description": "You 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", "syntax": "", "path": "/products/snake-venom", "raw_liquid": "{% assign images = product.media | where: 'media_type', 'image' %}\n\n{% for image in images %}\n {{- image | image_url: width: 300 | image_tag }}\n{% endfor %}", @@ -142,7 +142,7 @@ "name": "alt" } ], - "summary": "An abstract media object that can represent the following object types:\n\n- [`image`](/api/liquid/objects/image)\n- [`model`](/api/liquid/objects/model)\n- [`video`](/api/liquid/objects/video)\n- [`external_video`](/api/liquid/objects/external_video)", + "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)", "name": "media", "examples": [ @@ -199,7 +199,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`format_address` filter](/api/liquid/filters/format_address) to output an address according to its locale.", + "description": "> Tip:\n> Use the [`format_address` filter](/docs/api/liquid/filters/format_address) to output an address according to its locale.", "properties": [ { "deprecated": false, @@ -538,7 +538,7 @@ "properties": [ ], - "summary": "All of the [collections](/api/liquid/objects/collection) on a store.", + "summary": "All of the [collections](/docs/api/liquid/objects/collection) on a store.", "name": "collections", "examples": [ { @@ -553,7 +553,7 @@ }, { "name": "Access a specific collection", - "description": "You can use `collections` to access a collection by its [handle](/api/liquid/basics#handles).\n", + "description": "You can use `collections` to access a collection by its [handle](/docs/api/liquid/basics#handles).\n", "syntax": "", "path": "/", "raw_liquid": "{% for product in collections['sale-potions'].products %}\n {{- product.title | link_to: product.url }}\n{% endfor %}", @@ -592,12 +592,12 @@ "properties": [ ], - "summary": "All of the [pages](/api/liquid/objects/page) on a store.", + "summary": "All of the [pages](/docs/api/liquid/objects/page) on a store.", "name": "pages", "examples": [ { "name": "", - "description": "You can access a specific page through the `pages` object using the page's [handle](/api/liquid/basics#handles).\n", + "description": "You can access a specific page through the `pages` object using the page's [handle](/docs/api/liquid/basics#handles).\n", "syntax": "", "path": "/", "raw_liquid": "{{ pages.contact.title }}\n{{ pages['about-us'].title }}", @@ -607,7 +607,7 @@ }, { "name": "Paginate the `pages` object", - "description": "You can [paginate](/api/liquid/tags/paginate) the `pages` object, allowing you to iterate over up to 50 pages at a time.\n", + "description": "You can [paginate](/docs/api/liquid/tags/paginate) the `pages` object, allowing you to iterate over up to 50 pages at a time.\n", "syntax": "", "path": "/", "raw_liquid": "{% paginate pages by 2 -%}\n {% for page in pages -%}\n {{ page.title | link_to: page.url }}\n {%- endfor %}\n\n {{- paginate | default_pagination }}\n{%- endpaginate %}", @@ -651,7 +651,7 @@ "examples": [ { "name": "", - "description": "You can use `all_products` to access a product by its [handle](/api/liquid/basics#handles). If the product isn't found, then `nil` is returned.", + "description": "You can use `all_products` to access a product by its [handle](/docs/api/liquid/basics#handles). If the product isn't found, then `nil` is returned.", "syntax": "", "path": "/", "raw_liquid": "{{ all_products['love-potion'].title }}", @@ -698,7 +698,7 @@ "return_type": [ ], - "summary": "The [metafields](/api/liquid/objects/metafield) that are [owned by the app](/apps/metafields/app-owned).", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) that are [owned by the app](/apps/metafields/app-owned).", "name": "metafields" } ], @@ -742,13 +742,13 @@ ] }, "deprecated": true, - "deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `discount` object has been replaced by the [`discount_allocation`](/api/liquid/objects/discount_allocation) and\n[`discount_application`](/api/liquid/objects/discount_application) objects.", + "deprecation_reason": "Deprecated 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.", "description": "", "properties": [ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`discount.total_amount`](/api/liquid/objects/discount#discount-total_amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "> Note:\n> This is the same value as [`discount.total_amount`](/docs/api/liquid/objects/discount#discount-total_amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -766,7 +766,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`discount.amount`](/api/liquid/objects/discount#discount-amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "> Note:\n> This is the same value as [`discount.amount`](/docs/api/liquid/objects/discount#discount-amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -784,7 +784,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`discount.title`](/api/liquid/objects/discount#discount-title).", + "description": "> Note:\n> This is the same value as [`discount.title`](/docs/api/liquid/objects/discount#discount-title).", "examples": [ ], @@ -802,7 +802,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`discount.code`](/api/liquid/objects/discount#discount-code).", + "description": "> Note:\n> This is the same value as [`discount.code`](/docs/api/liquid/objects/discount#discount-code).", "examples": [ ], @@ -850,7 +850,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`discount.total_savings`](/api/liquid/objects/discount#discount-total_savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "> Note:\n> This is the same value as [`discount.total_savings`](/docs/api/liquid/objects/discount#discount-total_savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -868,7 +868,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`discount.savings`](/api/liquid/objects/discount#discount-savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "> Note:\n> This is the same value as [`discount.savings`](/docs/api/liquid/objects/discount#discount-savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -919,7 +919,7 @@ "examples": [ { "name": "", - "description": "You can use `articles` to access an article by its [handle](/api/liquid/basics#handles).\n", + "description": "You can use `articles` to access an article by its [handle](/docs/api/liquid/basics#handles).\n", "syntax": "", "path": "/", "raw_liquid": "{% assign article = articles['potion-notions/new-potions-for-spring'] %}\n{{ article.title | link_to: article.url }}", @@ -1014,7 +1014,7 @@ "array_value": "" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the article.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the article.", "name": "metafields" }, { @@ -1032,7 +1032,7 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the article.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the article.", "name": "handle" }, { @@ -1110,7 +1110,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -1128,7 +1128,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -1146,7 +1146,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -1182,7 +1182,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "Returns an empty array if comments are disabled.\n\n> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many comments to show at once, up to a limit of 50.", + "description": "Returns an empty array if comments are disabled.\n\n> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many comments to show at once, up to a limit of 50.", "examples": [ ], @@ -1302,7 +1302,7 @@ "array_value": "" } ], - "summary": "Returns the article [excerpt](/api/liquid/objects/article#article-excerpt) if it exists. Returns the article\n[content](/api/liquid/objects/article#article-content) if no excerpt exists.", + "summary": "Returns the article [excerpt](/docs/api/liquid/objects/article#article-excerpt) if it exists. Returns the article\n[content](/docs/api/liquid/objects/article#article-content) if no excerpt exists.", "name": "excerpt_or_content" }, { @@ -1490,7 +1490,7 @@ "examples": [ { "name": "", - "description": "You can use `blogs` to access a blog by its [handle](/api/liquid/basics#handles).\n", + "description": "You can use `blogs` to access a blog by its [handle](/docs/api/liquid/basics#handles).\n", "syntax": "", "path": "/", "raw_liquid": "{% for article in blogs.potion-notions.articles %}\n {{- article.title | link_to: article.url }}\n{% endfor %}", @@ -1579,13 +1579,13 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the blog.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the blog.", "name": "handle" }, { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many articles to show per page, up to a limit of 50.", + "description": "> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many articles to show per page, up to a limit of 50.", "examples": [ ], @@ -1633,7 +1633,7 @@ "array_value": "metafield" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the blog.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the blog.", "name": "metafields" }, { @@ -1705,7 +1705,7 @@ "array_value": "string" } ], - "summary": "A list of all of the tags on all of the articles in the blog.\n\nUnlike [`blog.all_tags`](/api/liquid/objects/blog#blog-all_tags), this property only returns tags of articles that are in the\nfiltered view.", + "summary": "A list of all of the tags on all of the articles in the blog.\n\nUnlike [`blog.all_tags`](/docs/api/liquid/objects/blog#blog-all_tags), this property only returns tags of articles that are in the\nfiltered view.", "name": "tags" }, { @@ -1875,7 +1875,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -1893,7 +1893,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -1911,7 +1911,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -1929,7 +1929,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -1947,7 +1947,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -2001,7 +2001,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "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> Tip:\n> You can output the store's available currencies using [`shop.enabled_currencies`](/api/liquid/objects/shop#shop-enabled_currencies).", + "description": "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> Tip:\n> You can output the store's available currencies using [`shop.enabled_currencies`](/docs/api/liquid/objects/shop#shop-enabled_currencies).", "examples": [ ], @@ -2112,7 +2112,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because not all discount types and details are available.\n\nThe `cart.discounts` property has been replaced by [`cart.discount_applications`](/api/liquid/objects/cart#cart-discount_applications).", + "deprecation_reason": "Deprecated 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).", "description": "", "examples": [ @@ -2193,7 +2193,7 @@ "array_value": "metafield" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the collection.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the collection.", "name": "metafields" }, { @@ -2229,7 +2229,7 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the collection.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the collection.", "name": "handle" }, { @@ -2343,7 +2343,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -2532,7 +2532,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many products to show per page, up to a limit of 50.", + "description": "> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many products to show per page, up to a limit of 50.", "examples": [ ], @@ -2550,7 +2550,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This includes products that have been filtered out of the current view.\n\n> Tip:\n> To display the number of products in a filtered collection, use [`collection.products_count`](/api/liquid/objects/collection#collection-products_count).", + "description": "This includes products that have been filtered out of the current view.\n\n> Tip:\n> To display the number of products in a filtered collection, use [`collection.products_count`](/docs/api/liquid/objects/collection#collection-products_count).", "examples": [ ], @@ -2568,7 +2568,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "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> Tip:\n> To display the tags that are currently applied, use [`collection.tags`](/api/liquid/objects/collection#collection-tags).", + "description": "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> Tip:\n> To display the tags that are currently applied, use [`collection.tags`](/docs/api/liquid/objects/collection#collection-tags).", "examples": [ ], @@ -2608,7 +2608,7 @@ "examples": [ { "name": "Create links to product types", - "description": "Use the [`link_to_type`](/api/liquid/filters/link_to_type) filter to create links to the product types in a collection.\n", + "description": "Use the [`link_to_type`](/docs/api/liquid/filters/link_to_type) filter to create links to the product types in a collection.\n", "syntax": "", "path": "/collections/ingredients", "raw_liquid": "{% for product_type in collection.all_types -%}\n {{- product_type | link_to_type }}\n{%- endfor %}", @@ -2635,7 +2635,7 @@ "examples": [ { "name": "Create links to vendors", - "description": "Use the [`link_to_vendor`](/api/liquid/filters/link_to_vendor) filter to create links to the vendors in a collection.\n", + "description": "Use the [`link_to_vendor`](/docs/api/liquid/filters/link_to_vendor) filter to create links to the vendors in a collection.\n", "syntax": "", "path": "/collections/ingredients", "raw_liquid": "{% for product_vendor in collection.all_vendors %}\n {{- product_vendor | link_to_vendor }}\n{% endfor %}", @@ -2676,7 +2676,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The default is the [collection image](/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.", + "description": "The default is the [collection image](/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.", "examples": [ ], @@ -2718,7 +2718,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use [color filters](/api/liquid/filters/color-filters) to modify or extract properties of a `color` object.", + "description": "> Tip:\n> Use [color filters](/docs/api/liquid/filters/color-filters) to modify or extract properties of a `color` object.", "properties": [ { "deprecated": false, @@ -3212,7 +3212,7 @@ "name": "available_locations" } ], - "summary": "A company that a [customer](/api/liquid/objects/customer) is purchasing for.", + "summary": "A company that a [customer](/docs/api/liquid/objects/customer) is purchasing for.", "name": "company", "examples": [ @@ -3378,7 +3378,7 @@ "name": "tax_registration_id" } ], - "summary": "A location of the [company](/api/liquid/objects/company) that a [customer](/api/liquid/objects/customer) is purchasing for.", + "summary": "A location of the [company](/docs/api/liquid/objects/company) that a [customer](/docs/api/liquid/objects/customer) is purchasing for.", "name": "company_location", "examples": [ @@ -3688,7 +3688,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "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](/themes/architecture/templates/customers-account)\n- The [`customers/addresses` template](/themes/architecture/templates/customers-addresses)\n- The [`customers/order` template](/themes/architecture/templates/customers-order)\n- When accessing [`checkout.customer`](/api/liquid/objects/checkout#checkout-customer)\n- When accessing [`gift_card.customer`](/api/liquid/objects/gift_card#gift_card-customer)\n- When accessing [`order.customer`](/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`.", + "description": "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](/themes/architecture/templates/customers-account)\n- The [`customers/addresses` template](/themes/architecture/templates/customers-addresses)\n- The [`customers/order` template](/themes/architecture/templates/customers-order)\n- When accessing [`checkout.customer`](/docs/api/liquid/objects/checkout#checkout-customer)\n- When accessing [`gift_card.customer`](/docs/api/liquid/objects/gift_card#gift_card-customer)\n- When accessing [`order.customer`](/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`.", "properties": [ { "deprecated": false, @@ -3747,7 +3747,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -3765,7 +3765,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many orders to show at once, up to a limit of 20.", + "description": "> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many orders to show at once, up to a limit of 20.", "examples": [ ], @@ -3945,7 +3945,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many addresses to show at once, up to a limit of 20.", + "description": "> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many addresses to show at once, up to a limit of 20.", "examples": [ ], @@ -4134,7 +4134,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -4192,7 +4192,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -4228,7 +4228,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "How this value is interpreted depends on the [value type](/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\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "How this value is interpreted depends on the [value type](/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\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -4246,7 +4246,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> Whether the selection method applies to line items or shipping lines depends on the discount's\n> [target type](/api/liquid/objects/discount_application#discount_application-target_type).", + "description": "> Note:\n> Whether the selection method applies to line items or shipping lines depends on the discount's\n> [target type](/docs/api/liquid/objects/discount_application#discount_application-target_type).", "examples": [ ], @@ -4387,7 +4387,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`external_video_tag` filter](/api/liquid/filters/external_video_tag) to output the video in an\n> HTML `<iframe>` tag. Use the [`external_video_url` filter](/api/liquid/filters/external_video_url) to specify parameters\n> for the external video player.", + "description": "> Tip:\n> Use the [`external_video_tag` filter](/docs/api/liquid/filters/external_video_tag) to output the video in an\n> HTML `<iframe>` tag. Use the [`external_video_url` filter](/docs/api/liquid/filters/external_video_url) to specify parameters\n> for the external video player.", "properties": [ { "deprecated": false, @@ -4492,7 +4492,7 @@ "examples": [ { "name": "Filter for media of a specific type", - "description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n", + "description": "You 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", "syntax": "", "path": "/products/potion-beats", "raw_liquid": "{% assign external_videos = product.media | where: 'media_type', 'external_video' %}\n\n{% for external_video in external_videos %}\n {{- external_video | external_video_tag }}\n{% endfor %}", @@ -4527,7 +4527,7 @@ "array_value": "" } ], - "summary": "The position of the external video in the [`product.media`](/api/liquid/objects/product#product-media) array.", + "summary": "The position of the external video in the [`product.media`](/docs/api/liquid/objects/product#product-media) array.", "name": "position" }, { @@ -5016,7 +5016,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "The focal point will remain visible when the image is cropped by the\ntheme. [Learn more about supporting focal points in your theme](https://shopify.dev/themes/architecture/settings/input-settings#image-focal-points).\n\n> Tip:\n> Use the [`image_tag`](/api/liquid/filters/image_tag) filter to automatically apply focal point settings to an\n> image on the storefront. This applies the focal point using the `object-position` CSS property.", + "description": "The focal point will remain visible when the image is cropped by the\ntheme. [Learn more about supporting focal points in your theme](https://shopify.dev/themes/architecture/settings/input-settings#image-focal-points).\n\n> Tip:\n> Use the [`image_tag`](/docs/api/liquid/filters/image_tag) filter to automatically apply focal point settings to an\n> image on the storefront. This applies the focal point using the `object-position` CSS property.", "properties": [ { "deprecated": false, @@ -5090,7 +5090,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "You can use the `font` object in Liquid [assets](/themes/architecture#assets) or inside a [`style` tag](/api/liquid/tags/style)\nto apply font setting values to theme CSS.\n\n> Tip:\n> Use [font filters](/api/liquid/filters/font-filters) to modify properties of the `font` object, load the font,\n> or obtain font variants.", + "description": "You can use the `font` object in Liquid [assets](/themes/architecture#assets) or inside a [`style` tag](/docs/api/liquid/tags/style)\nto apply font setting values to theme CSS.\n\n> Tip:\n> Use [font filters](/docs/api/liquid/filters/font-filters) to modify properties of the `font` object, load the font,\n> or obtain font variants.", "properties": [ { "deprecated": false, @@ -5203,7 +5203,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> You can use this property to determine whether you need to include a corresponding [font-face](/api/liquid/filters/font_face)\n> declaration for the font.", + "description": "> Tip:\n> You can use this property to determine whether you need to include a corresponding [font-face](/docs/api/liquid/filters/font_face)\n> declaration for the font.", "examples": [ ], @@ -5250,7 +5250,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If there are no errors, then `nil` is returned.\n\n> Tip:\n> You can apply the [`default_errors` filter](/api/liquid/filters/default_errors) to `form.errors` to output default\n> error messages without having to loop through the array.", + "description": "If there are no errors, then `nil` is returned.\n\n> Tip:\n> You can apply the [`default_errors` filter](/docs/api/liquid/filters/default_errors) to `form.errors` to output default\n> error messages without having to loop through the array.", "examples": [ ], @@ -5268,7 +5268,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5286,7 +5286,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5304,7 +5304,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`new_comment` form](/api/liquid/tags/form#form-new_comment).", + "description": "This property is exclusive to the [`new_comment` form](/docs/api/liquid/tags/form#form-new_comment).", "examples": [ ], @@ -5322,7 +5322,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`contact`](/api/liquid/tags/form#form-contact) and [`new_comment`](/api/liquid/tags/form#form-new_comment)\nforms.", + "description": "This property is exclusive to the [`contact`](/docs/api/liquid/tags/form#form-contact) and [`new_comment`](/docs/api/liquid/tags/form#form-new_comment)\nforms.", "examples": [ ], @@ -5340,7 +5340,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5358,7 +5358,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5376,7 +5376,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5394,7 +5394,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the following forms:\n\n- [`contact`](/api/liquid/tags/form#form-contact)\n- [`create_customer`](/api/liquid/tags/form#form-create_customer)\n- [`customer`](/api/liquid/tags/form#form-customer)\n- [`customer_login`](/api/liquid/tags/form#form-customer_login)\n- [`new_comment`](/api/liquid/tags/form#form-new_comment)\n- [`recover_customer_password`](/api/liquid/tags/form#form-recover_customer_password)", + "description": "This property is exclusive to the following forms:\n\n- [`contact`](/docs/api/liquid/tags/form#form-contact)\n- [`create_customer`](/docs/api/liquid/tags/form#form-create_customer)\n- [`customer`](/docs/api/liquid/tags/form#form-customer)\n- [`customer_login`](/docs/api/liquid/tags/form#form-customer_login)\n- [`new_comment`](/docs/api/liquid/tags/form#form-new_comment)\n- [`recover_customer_password`](/docs/api/liquid/tags/form#form-recover_customer_password)", "examples": [ ], @@ -5412,7 +5412,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`create_customer`](/api/liquid/tags/form#form-create_customer) and\n[`customer_address`](/api/liquid/tags/form#form-customer_address) forms.", + "description": "This property is exclusive to the [`create_customer`](/docs/api/liquid/tags/form#form-create_customer) and\n[`customer_address`](/docs/api/liquid/tags/form#form-customer_address) forms.", "examples": [ ], @@ -5448,7 +5448,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`create_customer`](/api/liquid/tags/form#form-create_customer) and\n[`customer_address`](/api/liquid/tags/form#form-customer_address) forms.", + "description": "This property is exclusive to the [`create_customer`](/docs/api/liquid/tags/form#form-create_customer) and\n[`customer_address`](/docs/api/liquid/tags/form#form-customer_address) forms.", "examples": [ ], @@ -5466,7 +5466,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_login` form](/api/liquid/tags/form#form-customer_login).", + "description": "This property is exclusive to the [`customer_login` form](/docs/api/liquid/tags/form#form-customer_login).", "examples": [ ], @@ -5484,7 +5484,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5502,7 +5502,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> The [`customer_address` form](/api/liquid/tags/form#form-customer_address) always returns `true`.", + "description": "> Note:\n> The [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address) always returns `true`.", "examples": [ ], @@ -5520,7 +5520,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5538,7 +5538,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5556,7 +5556,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).", + "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", "examples": [ ], @@ -5572,7 +5572,7 @@ "name": "zip" } ], - "summary": "Information about a form created by a [`form` tag](/api/liquid/tags/form).", + "summary": "Information about a form created by a [`form` tag](/docs/api/liquid/tags/form).", "name": "form", "examples": [ @@ -5606,7 +5606,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -5830,7 +5830,7 @@ "array_value": "" } ], - "summary": "The position of the media in the [`product.media` array](/api/liquid/objects/product#product-media).", + "summary": "The position of the media in the [`product.media` array](/docs/api/liquid/objects/product#product-media).", "name": "position" }, { @@ -5852,7 +5852,7 @@ "name": "alt" } ], - "summary": "A file from a `file_reference` type [metafield](/api/liquid/objects/metafield) that is neither an image or video.", + "summary": "A file from a `file_reference` type [metafield](/docs/api/liquid/objects/metafield) that is neither an image or video.", "name": "generic_file", "examples": [ @@ -5883,7 +5883,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -5991,7 +5991,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If the gift card never expires, then `nil` is returned.\n> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "If the gift card never expires, then `nil` is returned.\n> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -6009,7 +6009,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -6063,7 +6063,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If there aren't any line item properties, then an [`EmptyDrop`](/api/liquid/basics#emptydrop) is returned.", + "description": "If there aren't any line item properties, then an [`EmptyDrop`](/docs/api/liquid/basics#emptydrop) is returned.", "examples": [ ], @@ -6075,7 +6075,7 @@ "array_value": "untyped" } ], - "summary": "The [line item properties](/api/liquid/objects/line_item#line_item-properties) assigned to the gift card.", + "summary": "The [line item properties](/docs/api/liquid/objects/line_item#line_item-properties) assigned to the gift card.", "name": "properties" }, { @@ -6248,7 +6248,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "To learn about the image formats that Shopify supports, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/images/theme-images#image-formats).\n\n> Tip:\n> Use the [`image_url`](/api/liquid/filters/image_url) and [`image_tag`](/api/liquid/filters/image_tag) filters to display\n> images on the storefront.", + "description": "To learn about the image formats that Shopify supports, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/images/theme-images#image-formats).\n\n> Tip:\n> Use the [`image_url`](/docs/api/liquid/filters/image_url) and [`image_tag`](/docs/api/liquid/filters/image_tag) filters to display\n> images on the storefront.", "properties": [ { "deprecated": false, @@ -6361,7 +6361,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The `attached_to_variant?` property is only available for images accessed through the following sources:\n\n- [`product.featured_image`](/api/liquid/objects/product#product-featured_image)\n- [`product.images`](/api/liquid/objects/product#product-images)\n\nIf you reference this property on an image from another source, then `nil` is returned.", + "description": "The `attached_to_variant?` property is only available for images accessed through the following sources:\n\n- [`product.featured_image`](/docs/api/liquid/objects/product#product-featured_image)\n- [`product.images`](/docs/api/liquid/objects/product#product-images)\n\nIf you reference this property on an image from another source, then `nil` is returned.", "examples": [ ], @@ -6379,7 +6379,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If you reference the `id` property for preview images of [`generic_file`](/api/liquid/objects/generic_file) or\n[`media`](/api/liquid/objects/media) objects, then `nil` is returned.", + "description": "If you reference the `id` property for preview images of [`generic_file`](/docs/api/liquid/objects/generic_file) or\n[`media`](/docs/api/liquid/objects/media) objects, then `nil` is returned.", "examples": [ ], @@ -6397,11 +6397,11 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The `media_type` property is only available for images accessed through the following sources:\n\n- [`product.media`](/api/liquid/objects/product#product-media)\n- [`file_reference` type metafields](/apps/metafields/types#supported-types)\n\nIf you reference this property on an image from another source, then `nil` is returned.", + "description": "The `media_type` property is only available for images accessed through the following sources:\n\n- [`product.media`](/docs/api/liquid/objects/product#product-media)\n- [`file_reference` type metafields](/apps/metafields/types#supported-types)\n\nIf you reference this property on an image from another source, then `nil` is returned.", "examples": [ { "name": "Filter for media of a specific type", - "description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n", + "description": "You 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", "syntax": "", "path": "/products/snake-venom", "raw_liquid": "{% assign images = product.media | where: 'media_type', 'image' %}\n\n{% for image in images %}\n {{- image | image_url: width: 300 | image_tag }}\n{% endfor %}", @@ -6436,13 +6436,13 @@ "array_value": "" } ], - "summary": "The position of the image in the [`product.images`](/api/liquid/objects/product#product-images) or [`product.media`](/api/liquid/objects/product#product-media)\narray.", + "summary": "The position of the image in the [`product.images`](/docs/api/liquid/objects/product#product-images) or [`product.media`](/docs/api/liquid/objects/product#product-media)\narray.", "name": "position" }, { "deprecated": false, "deprecation_reason": "", - "description": "The `preview_image` property is only available for images accessed through the following sources:\n\n- [`product.featured_media`](/api/liquid/objects/product#product-featured_media)\n- [`product.media`](/api/liquid/objects/product#product-media)\n- [`file_reference` type metafields](/apps/metafields/types#supported-types)\n\nIf you reference this property on an image from another source, then `nil` is returned.", + "description": "The `preview_image` property is only available for images accessed through the following sources:\n\n- [`product.featured_media`](/docs/api/liquid/objects/product#product-featured_media)\n- [`product.media`](/docs/api/liquid/objects/product#product-media)\n- [`file_reference` type metafields](/apps/metafields/types#supported-types)\n\nIf you reference this property on an image from another source, then `nil` is returned.", "examples": [ ], @@ -6478,7 +6478,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The `variants` property is only available for images accessed through the following sources:\n\n- [`product.featured_image`](/api/liquid/objects#product-featured_image)\n- [`product.images`](/api/liquid/objects/product#product-images)\n\nIf you reference this property on an image from another source, then `nil` is returned.", + "description": "The `variants` property is only available for images accessed through the following sources:\n\n- [`product.featured_image`](/docs/api/liquid/objects#product-featured_image)\n- [`product.images`](/docs/api/liquid/objects/product#product-images)\n\nIf you reference this property on an image from another source, then `nil` is returned.", "examples": [ ], @@ -6588,7 +6588,7 @@ "properties": [ ], - "summary": "All of the [images](/api/liquid/objects/image) that have been [uploaded](https://help.shopify.com/manual/online-store/images/theme-images#upload-images)\nto a store.", + "summary": "All of the [images](/docs/api/liquid/objects/image) that have been [uploaded](https://help.shopify.com/manual/online-store/images/theme-images#upload-images)\nto a store.", "name": "images", "examples": [ { @@ -6644,7 +6644,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The ID differs depending on the context. The following table outlines the possible contexts and their associated values:\n\n| Context | Value |\n| --- | --- |\n| [`cart.items`](/api/liquid/objects/cart#cart-items) | The ID of the line item's variant.<br><br>This ID isn't unique, and can be shared by multiple items with the same variant. |\n| [`checkout.line_items`](/api/liquid/objects/checkout#checkout-line_items) | A temporary unique hash generated for the checkout. |\n| [`order.line_items`](/api/liquid/objects/order#order-line_items) | A unique integer ID. |", + "description": "The ID differs depending on the context. The following table outlines the possible contexts and their associated values:\n\n| Context | Value |\n| --- | --- |\n| [`cart.items`](/docs/api/liquid/objects/cart#cart-items) | The ID of the line item's variant.<br><br>This ID isn't unique, and can be shared by multiple items with the same variant. |\n| [`checkout.line_items`](/docs/api/liquid/objects/checkout#checkout-line_items) | A temporary unique hash generated for the checkout. |\n| [`order.line_items`](/docs/api/liquid/objects/order#order-line_items) | A unique integer ID. |", "examples": [ ], @@ -6679,8 +6679,8 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.price` property has been replaced by [`line_item.final_price`](/api/liquid/objects/line_item#line_item-final_price).", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.price` property has been replaced by [`line_item.final_price`](/docs/api/liquid/objects/line_item#line_item-final_price).", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -6697,8 +6697,8 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.line_price` property has been replaced by [`line_item.final_line_price`](/api/liquid/objects/line_item#line_item-final_line_price).", - "description": "The value is equal to `line_item.price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.line_price` property has been replaced by [`line_item.final_line_price`](/docs/api/liquid/objects/line_item#line_item-final_line_price).", + "description": "The value is equal to `line_item.price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -6715,8 +6715,8 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.total_discount` property has been replaced by [`line_item.line_level_total_discount`](/api/liquid/objects/line_item#line_item-line_level_total_discount).", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.total_discount` property has been replaced by [`line_item.line_level_total_discount`](/docs/api/liquid/objects/line_item#line_item-line_level_total_discount).", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -6752,7 +6752,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -6770,7 +6770,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is equal to `line_item.final_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is equal to `line_item.final_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -6800,7 +6800,7 @@ "array_value": "" } ], - "summary": "The [ID](/api/liquid/objects/variant#variant-id) of the line item's variant.", + "summary": "The [ID](/docs/api/liquid/objects/variant#variant-id) of the line item's variant.", "name": "variant_id" }, { @@ -6818,7 +6818,7 @@ "array_value": "" } ], - "summary": "The [ID](/api/liquid/objects/product#product-id) of the line item's product.", + "summary": "The [ID](/docs/api/liquid/objects/product#product-id) of the line item's product.", "name": "product_id" }, { @@ -6936,7 +6936,7 @@ "examples": [ { "name": "Capture line item properties in the product form", - "description": "To capture line item properties inside the [product form](/api/liquid/tags/form#form-product), you need to include an input, for each property. Each input needs a unique `name` attribute. Use the following format:\n\n```\nname=\"properties[property-name]\"\n```\n\nThe value of the input is captured as the value of the property.\n\nFor example, you can use the following code to capture custom engraving text for a product:\n\n```liquid\n{% form 'product', product %}\n ...\n <label for=\"engravingText\">Engraving<label>\n <input type=\"text\" id=\"engravingText\" name=\"properties[Engraving]\">\n ...\n{% endform %}\n```\n\n> Tip:\n> You can add an underscore to the beginning of a property name to hide it from customers at checkout. For example,\n> `properties[_hiddenPropertyName]`.\n", + "description": "To capture line item properties inside the [product form](/docs/api/liquid/tags/form#form-product), you need to include an input, for each property. Each input needs a unique `name` attribute. Use the following format:\n\n```\nname=\"properties[property-name]\"\n```\n\nThe value of the input is captured as the value of the property.\n\nFor example, you can use the following code to capture custom engraving text for a product:\n\n```liquid\n{% form 'product', product %}\n ...\n <label for=\"engravingText\">Engraving<label>\n <input type=\"text\" id=\"engravingText\" name=\"properties[Engraving]\">\n ...\n{% endform %}\n```\n\n> Tip:\n> You can add an underscore to the beginning of a property name to hide it from customers at checkout. For example,\n> `properties[_hiddenPropertyName]`.\n", "syntax": "", "path": "/products/health-potion", "raw_liquid": "", @@ -6977,7 +6977,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -7007,13 +7007,13 @@ "array_value": "" } ], - "summary": "The [sku](/api/liquid/objects/variant#variant-sku) of the variant associated with the line item.", + "summary": "The [sku](/docs/api/liquid/objects/variant#variant-sku) of the variant associated with the line item.", "name": "sku" }, { "deprecated": false, "deprecation_reason": "", - "description": "The following table outlines what's returned depending on the number of discounts affecting the line item:\n\n| Number of discounts | Value |\n| --- | --- |\n| 0 | `nil` |\n| 1 | The [title](/api/liquid/objects/discount_application#discount_application-title) of the discount. |\n| More than 1 | A Shopify generated string noting how many discounts have been applied. |", + "description": "The following table outlines what's returned depending on the number of discounts affecting the line item:\n\n| Number of discounts | Value |\n| --- | --- |\n| 0 | `nil` |\n| 1 | The [title](/docs/api/liquid/objects/discount_application#discount_application-title) of the discount. |\n| More than 1 | A Shopify generated string noting how many discounts have been applied. |", "examples": [ ], @@ -7049,7 +7049,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "In most contexts, the line item title appears in the customer's preferred language. However, in the context of an\n[order](/api/liquid/objects/order), the line item title appears in the language that the customer checked out in.\n\n#### Line item title history\n\nWhen referencing line item, product, and variant titles in the context of an order, the following changes might result\nin a different output than you expect:\n\n- A product or variant being deleted\n- A product or variant title being edited\n\nWhen `line_item.title` is referenced for an order, the line item title at the time of the order is returned.\nHowever, when `line_item.product.title` and `line_item.variant.title` are referenced, the current value for\neach title is returned.", + "description": "In most contexts, the line item title appears in the customer's preferred language. However, in the context of an\n[order](/docs/api/liquid/objects/order), the line item title appears in the language that the customer checked out in.\n\n#### Line item title history\n\nWhen referencing line item, product, and variant titles in the context of an order, the following changes might result\nin a different output than you expect:\n\n- A product or variant being deleted\n- A product or variant title being edited\n\nWhen `line_item.title` is referenced for an order, the line item title at the time of the order is returned.\nHowever, when `line_item.product.title` and `line_item.variant.title` are referenced, the current value for\neach title is returned.", "examples": [ ], @@ -7085,7 +7085,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -7103,7 +7103,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is equal to `line_item.original_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is equal to `line_item.original_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -7121,7 +7121,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -7156,7 +7156,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.discounts` property has been replaced by [`line_item.discount_allocations`](/api/liquid/objects/line_item#line_item-discount_allocations).", + "deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.discounts` property has been replaced by [`line_item.discount_allocations`](/docs/api/liquid/objects/line_item#line_item-discount_allocations).", "description": "", "examples": [ @@ -7210,7 +7210,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because not all discount types and details are available.\n\nThe `line_item.discounts` property has been replaced by [`line_item.discount_allocations`](/api/liquid/objects/line_item#line_item-discount_allocations).", + "deprecation_reason": "Deprecated because not all discount types and details are available.\n\nThe `line_item.discounts` property has been replaced by [`line_item.discount_allocations`](/docs/api/liquid/objects/line_item#line_item-discount_allocations).", "description": "", "examples": [ @@ -7274,7 +7274,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use this property with the [`weight_with_unit` filter](/api/liquid/filters/weight_with_unit) to format the weight.", + "description": "> Tip:\n> Use this property with the [`weight_with_unit` filter](/docs/api/liquid/filters/weight_with_unit) to format the weight.", "examples": [ ], @@ -7346,7 +7346,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "#### Availability of selling plan information\n\nThe following properties aren't available when referencing selling plan information through an\n[order's line items](/api/liquid/objects/order#order-line_items):\n\n- [`selling_plan_allocation.compare_at_price`](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-compare_at_price)\n- [`selling_plan_allocation.price_adjustments`](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments)\n- [`selling_plan_allocation.selling_plan.group_id`](/api/liquid/objects/selling_plan#selling_plan-group_id)\n- [`selling_plan_allocation.selling_plan.options`](/api/liquid/objects/selling_plan#selling_plan-options)\n- [`selling_plan_allocation.selling_plan.price_adjustments`](/api/liquid/objects/selling_plan#selling_plan-price_adjustments)\n- [`selling_plan_allocation.selling_plan_group_id`](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-selling_plan_group_id)\n\n> Tip:\n> If you need to show selling plan information post-purchase, then you should use [`selling_plan.name`](/api/liquid/objects/selling_plan#selling_plan-name).", + "description": "#### Availability of selling plan information\n\nThe following properties aren't available when referencing selling plan information through an\n[order's line items](/docs/api/liquid/objects/order#order-line_items):\n\n- [`selling_plan_allocation.compare_at_price`](/docs/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-compare_at_price)\n- [`selling_plan_allocation.price_adjustments`](/docs/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments)\n- [`selling_plan_allocation.selling_plan.group_id`](/docs/api/liquid/objects/selling_plan#selling_plan-group_id)\n- [`selling_plan_allocation.selling_plan.options`](/docs/api/liquid/objects/selling_plan#selling_plan-options)\n- [`selling_plan_allocation.selling_plan.price_adjustments`](/docs/api/liquid/objects/selling_plan#selling_plan-price_adjustments)\n- [`selling_plan_allocation.selling_plan_group_id`](/docs/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-selling_plan_group_id)\n\n> Tip:\n> If you need to show selling plan information post-purchase, then you should use [`selling_plan.name`](/docs/api/liquid/objects/selling_plan#selling_plan-name).", "examples": [ ], @@ -7396,7 +7396,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "A link is considered to be active if the current URL path matches, or contains, the link's [url](/api/liquid/objects/link#link-url).\nFor example, if the current URL path is `/blog/potion-notions/new-potions-for-spring`, then the following link URLs\nwould be considered active:\n\n- `/blog/potion-notions/new-potions-for-spring`\n- `/blog/potion-notions`\n\n> Tip:\n> The `link.active` property is useful for menu designs that highlight when top-level navigation categories are being\n> viewed. For example, if a customer is viewing an article from the \"Potion notions\" blog, then the \"Potion notions\" link\n> is highlighted in the menu.", + "description": "A link is considered to be active if the current URL path matches, or contains, the link's [url](/docs/api/liquid/objects/link#link-url).\nFor example, if the current URL path is `/blog/potion-notions/new-potions-for-spring`, then the following link URLs\nwould be considered active:\n\n- `/blog/potion-notions/new-potions-for-spring`\n- `/blog/potion-notions`\n\n> Tip:\n> The `link.active` property is useful for menu designs that highlight when top-level navigation categories are being\n> viewed. For example, if a customer is viewing an article from the \"Potion notions\" blog, then the \"Potion notions\" link\n> is highlighted in the menu.", "examples": [ ], @@ -7414,7 +7414,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> URL parameters are ignored when determining a match.\n>\n> Product URLs [within the context of a collection](/api/liquid/filters/within) are treated as equal to a standard product\n> URL for the same product.", + "description": "> Note:\n> URL parameters are ignored when determining a match.\n>\n> Product URLs [within the context of a collection](/docs/api/liquid/filters/within) are treated as equal to a standard product\n> URL for the same product.", "examples": [ ], @@ -7426,13 +7426,13 @@ "array_value": "" } ], - "summary": "Returns `true` if the current URL path matches the [URL](/api/liquid/objects/link#link-url) of the link. Returns `false` if not.", + "summary": "Returns `true` if the current URL path matches the [URL](/docs/api/liquid/objects/link#link-url) of the link. Returns `false` if not.", "name": "current" }, { "deprecated": false, "deprecation_reason": "", - "description": "A link is considered to be active if the current URL path matches, or contains, the [URL](/api/liquid/objects/link#link-url) of\nthe link.\n\nFor example, if the current URL path is `/blog/potion-notions/new-potions-for-spring`, then the following link URLs\nwould be considered active:\n\n- `/blog/potion-notions/new-potions-for-spring`\n- `/blog/potion-notions`", + "description": "A link is considered to be active if the current URL path matches, or contains, the [URL](/docs/api/liquid/objects/link#link-url) of\nthe link.\n\nFor example, if the current URL path is `/blog/potion-notions/new-potions-for-spring`, then the following link URLs\nwould be considered active:\n\n- `/blog/potion-notions/new-potions-for-spring`\n- `/blog/potion-notions`", "examples": [ ], @@ -7450,7 +7450,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> URL parameters are ignored when determining a match.\n>\n> Product URLs [within the context of a collection](/api/liquid/filters/within) and standard product URLs are treated\n> the same.", + "description": "> Note:\n> URL parameters are ignored when determining a match.\n>\n> Product URLs [within the context of a collection](/docs/api/liquid/filters/within) and standard product URLs are treated\n> the same.", "examples": [ ], @@ -7462,7 +7462,7 @@ "array_value": "" } ], - "summary": "Returns `true` if current URL path matches a link's child link [URL](/api/liquid/objects/link#link-url). Returns `false` if not.", + "summary": "Returns `true` if current URL path matches a link's child link [URL](/docs/api/liquid/objects/link#link-url). Returns `false` if not.", "name": "child_current" }, { @@ -7480,7 +7480,7 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the link.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the link.", "name": "handle" }, { @@ -7513,7 +7513,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The object can be one of the following:\n\n- [`article`](/api/liquid/objects/article)\n- [`blog`](/api/liquid/objects/blog)\n- [`collection`](/api/liquid/objects/collection)\n- [`page`](/api/liquid/objects/page)\n- [`policy`](/api/liquid/objects/policy)\n- [`product`](/api/liquid/objects/product)", + "description": "The object can be one of the following:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`blog`](/docs/api/liquid/objects/blog)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`page`](/docs/api/liquid/objects/page)\n- [`policy`](/docs/api/liquid/objects/policy)\n- [`product`](/docs/api/liquid/objects/product)", "examples": [ ], @@ -7696,7 +7696,7 @@ "examples": [ { "name": "", - "description": "You can access a specific menu through the `linklists` object using the menu's [handle](/api/liquid/basics#handles).\n", + "description": "You can access a specific menu through the `linklists` object using the menu's [handle](/docs/api/liquid/basics#handles).\n", "syntax": "", "path": "/", "raw_liquid": "<!-- Main menu -->\n{% for link in linklists.main-menu.links -%}\n {{ link.title | link_to: link.url }}\n{%- endfor %}\n\n<!-- Footer menu -->\n{% for link in linklists['footer'].links -%}\n {{ link.title | link_to: link.url }}\n{%- endfor %}", @@ -7769,7 +7769,7 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the menu.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the menu.", "name": "handle" }, { @@ -7994,7 +7994,7 @@ "name": "last" } ], - "summary": "Information about a parent [`for` loop](/api/liquid/tags/for).", + "summary": "Information about a parent [`for` loop](/docs/api/liquid/tags/for).", "name": "forloop", "examples": [ { @@ -8248,7 +8248,7 @@ "name": "col_last" } ], - "summary": "Information about a parent [`tablerow` loop](/api/liquid/tags/tablerow).", + "summary": "Information about a parent [`tablerow` loop](/docs/api/liquid/tags/tablerow).", "name": "tablerowloop", "examples": [ @@ -8274,7 +8274,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "The `localization` object can be used in a [localization form](/api/liquid/tags/form#form-localization).\n\nTo learn about how to offer localization options in your theme, refer to [Support multiple currencies and languages](/themes/internationalization/multiple-currencies-languages).", + "description": "The `localization` object can be used in a [localization form](/docs/api/liquid/tags/form#form-localization).\n\nTo learn about how to offer localization options in your theme, refer to [Support multiple currencies and languages](/themes/internationalization/multiple-currencies-languages).", "properties": [ { "deprecated": false, @@ -8485,7 +8485,7 @@ "array_value": "" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the location.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the location.", "name": "metafields" } ], @@ -8656,12 +8656,12 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "To learn about how to access a metafield on a specific object, refer to [Access metafields](/api/liquid/objects/metafield#metafield-access-metafields).\n\nMetafields support [multiple data types](/apps/metafields/types), which determine the kind of information that's stored\nin the metafield. You can also output the metafield content in a type-specific format using\n[metafield filters](/api/liquid/filters/metafield-filters).\n\n> Note:\n> You can't create metafields in Liquid. Metafields can be created in only the following ways:\n>\n> - [In the Shopify admin](https://help.shopify.com/manual/metafields)\n> - [Through an app](https://shopify.dev/apps/metafields)\n\n> Note:\n> Metafields of type `integer`, `json_string`, and `string` are older implementations that don't have the properties\n noted on this page, and aren't compatible with metafield filters. To learn more, refer to [Deprecated metafields](/api/liquid/objects/metafield#metafield-deprecated-metafields).", + "description": "To learn about how to access a metafield on a specific object, refer to [Access metafields](/docs/api/liquid/objects/metafield#metafield-access-metafields).\n\nMetafields support [multiple data types](/apps/metafields/types), which determine the kind of information that's stored\nin the metafield. You can also output the metafield content in a type-specific format using\n[metafield filters](/docs/api/liquid/filters/metafield-filters).\n\n> Note:\n> You can't create metafields in Liquid. Metafields can be created in only the following ways:\n>\n> - [In the Shopify admin](https://help.shopify.com/manual/metafields)\n> - [Through an app](https://shopify.dev/apps/metafields)\n\n> Note:\n> Metafields of type `integer`, `json_string`, and `string` are older implementations that don't have the properties\n noted on this page, and aren't compatible with metafield filters. To learn more, refer to [Deprecated metafields](/docs/api/liquid/objects/metafield#metafield-deprecated-metafields).", "properties": [ { "deprecated": false, "deprecation_reason": "", - "description": "The following table outlines the value format for each metafield type:\n\n<table>\n <thead>\n <tr>\n <th>Type</th>\n <th>Returned format</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <code>single_line_text_field</code><br><br>\n <code>multi_line_text_field</code>\n </td>\n <td><a href=\"/api/liquid/basics#string\">A string</a></td>\n </tr>\n <tr>\n <td>\n <code>product_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/product\">A product object</a></td>\n </tr>\n <tr>\n <td>\n <code>collection_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/collection\">A collection object</a></td>\n </tr>\n <tr>\n <td>\n <code>variant_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/variant\">A variant object</a></td>\n </tr>\n <tr>\n <td>\n <code>page_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/page\">A page object</a></td>\n </tr>\n <tr>\n <td>\n <code>file_reference</code>\n </td>\n <td>\n <a href=\"/api/liquid/objects/generic-file\">A generic_file object</a><br><br>\n <a href=\"/api/liquid/objects/media\">A media object (images and videos only)</a>\n </td>\n </tr>\n <tr>\n <td>\n <code>number_integer</code><br><br>\n <code>number_decimal</code>\n </td>\n <td><a href=\"/api/liquid/basics#number\">A number</a></td>\n </tr>\n <tr>\n <td>\n <code>date</code><br><br>\n <code>date_time</code>\n </td>\n <td>A date string. To format the string, use the <a href=\"/api/liquid/filters/date\">date</a> filter.</td>\n </tr>\n <tr>\n <td>\n <code>url_reference</code>\n </td>\n <td><a href=\"/api/liquid/basics#string\">A url string</a></td>\n </tr>\n <tr>\n <td>\n <code>json</code>\n </td>\n <td><a href=\"https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON\">A JSON object</a></td>\n </tr>\n <tr>\n <td>\n <code>boolean</code>\n </td>\n <td><a href=\"/api/liquid/basics#boolean\">A boolean</a></td>\n <tr>\n <td>\n <code>color</code>\n </td>\n <td><a href=\"/api/liquid/objects/color\">A color object</a></td>\n </tr>\n <tr>\n <td>\n <code>weight</code><br><br>\n <code>volume</code><br><br>\n <code>dimension</code>\n </td>\n <td><a href=\"/api/liquid/objects/measurement\">A measurement object</a></td>\n </tr>\n <tr>\n <td>\n <code>rating</code>\n </td>\n <td><a href=\"/api/liquid/objects/rating\">A rating object</a></td>\n </tr>\n <tr>\n <td>\n <code>list</code>\n </td>\n <td><a href=\"/api/liquid/basics#array\">An array of objects, numbers, or strings, depending on the list type</a></td>\n </tr>\n <tr>\n <td>\n <code>money</code>\n </td>\n <td><a href=\"/api/liquid/objects/money\">A money object, displayed in the customer's local (presentment) currency.</a></td>\n </tr>\n </tbody>\n</table>", + "description": "The following table outlines the value format for each metafield type:\n\n<table>\n <thead>\n <tr>\n <th>Type</th>\n <th>Returned format</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <code>single_line_text_field</code><br><br>\n <code>multi_line_text_field</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#string\">A string</a></td>\n </tr>\n <tr>\n <td>\n <code>product_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/product\">A product object</a></td>\n </tr>\n <tr>\n <td>\n <code>collection_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/collection\">A collection object</a></td>\n </tr>\n <tr>\n <td>\n <code>variant_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/variant\">A variant object</a></td>\n </tr>\n <tr>\n <td>\n <code>page_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/page\">A page object</a></td>\n </tr>\n <tr>\n <td>\n <code>file_reference</code>\n </td>\n <td>\n <a href=\"/docs/api/liquid/objects/generic-file\">A generic_file object</a><br><br>\n <a href=\"/docs/api/liquid/objects/media\">A media object (images and videos only)</a>\n </td>\n </tr>\n <tr>\n <td>\n <code>number_integer</code><br><br>\n <code>number_decimal</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#number\">A number</a></td>\n </tr>\n <tr>\n <td>\n <code>date</code><br><br>\n <code>date_time</code>\n </td>\n <td>A date string. To format the string, use the <a href=\"/docs/api/liquid/filters/date\">date</a> filter.</td>\n </tr>\n <tr>\n <td>\n <code>url_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#string\">A url string</a></td>\n </tr>\n <tr>\n <td>\n <code>json</code>\n </td>\n <td><a href=\"https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON\">A JSON object</a></td>\n </tr>\n <tr>\n <td>\n <code>boolean</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#boolean\">A boolean</a></td>\n <tr>\n <td>\n <code>color</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/color\">A color object</a></td>\n </tr>\n <tr>\n <td>\n <code>weight</code><br><br>\n <code>volume</code><br><br>\n <code>dimension</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/measurement\">A measurement object</a></td>\n </tr>\n <tr>\n <td>\n <code>rating</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/rating\">A rating object</a></td>\n </tr>\n <tr>\n <td>\n <code>list</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#array\">An array of objects, numbers, or strings, depending on the list type</a></td>\n </tr>\n <tr>\n <td>\n <code>money</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/money\">A money object, displayed in the customer's local (presentment) currency.</a></td>\n </tr>\n </tbody>\n</table>", "examples": [ ], @@ -8878,7 +8878,7 @@ }, { "name": "Deprecated metafields", - "description": "Deprecated metafields are older metafield types with limited functionality. The following metafield types are deprecated:\n\n- `integer`\n- `json_string`\n- `string`\n\nThese metafield types don't have the same metafield object properties mentioned in the previous sections. Instead, they return the metafield value directly.\n\nThe following table outlines the value type for each deprecated metafield type:\n\n| Metafield type | Value type |\n| --- | --- |\n| `integer` | [An integer](/api/liquid/basics#number) |\n| `json_string` | [A JSON object](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON) |\n| `string` | [A string](/api/liquid/basics#string) |\n", + "description": "Deprecated metafields are older metafield types with limited functionality. The following metafield types are deprecated:\n\n- `integer`\n- `json_string`\n- `string`\n\nThese metafield types don't have the same metafield object properties mentioned in the previous sections. Instead, they return the metafield value directly.\n\nThe following table outlines the value type for each deprecated metafield type:\n\n| Metafield type | Value type |\n| --- | --- |\n| `integer` | [An integer](/docs/api/liquid/basics#number) |\n| `json_string` | [A JSON object](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON) |\n| `string` | [A string](/docs/api/liquid/basics#string) |\n", "syntax": "", "path": "/", "raw_liquid": "", @@ -8908,7 +8908,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "One or more corresponding [`metaobject`](/api/liquid/objects#metaobject) objects contain values for\nthe fields specified in the metaobject definition.", + "description": "One or more corresponding [`metaobject`](/docs/api/liquid/objects#metaobject) objects contain values for\nthe fields specified in the metaobject definition.", "properties": [ { "deprecated": false, @@ -8925,7 +8925,7 @@ "array_value": "metaobject" } ], - "summary": "The [metaobjects](/api/liquid/objects#metaobject) that follow the definition.", + "summary": "The [metaobjects](/docs/api/liquid/objects#metaobject) that follow the definition.", "name": "values" }, { @@ -9001,12 +9001,12 @@ "name": "system" } ], - "summary": "A metaobject entry, which includes the values for a set of [fields](/api/liquid/objects#metafield).\nThe set is defined by the parent [`metaobject_definition`](/api/liquid/objects#metaobject_definition).", + "summary": "A metaobject entry, which includes the values for a set of [fields](/docs/api/liquid/objects#metafield).\nThe set is defined by the parent [`metaobject_definition`](/docs/api/liquid/objects#metaobject_definition).", "name": "metaobject", "examples": [ { "name": "Access metaobjects individually", - "description": "The access path for a metaobject consists of two layers:\n\n- type - The type of the parent metaobject definition.\n- handle - The unique [handle](/api/liquid/basics#handles) of the metaobject.\n\nGiven this, you can access a metaobject with the following syntax:\n\n```liquid\n{{ shop.metaobjects.type.handle }}\n```\n\nYou can also use square bracket notation:\n\n```liquid\n{{ shop.metaobjects['type']['handle'] }}\n```\n\nA metaobjects's field values can be accessed using the key of the desired field:\n\n```liquid\n{{ shop.metaobjects.testimonials.homepage.title }}\n{{ shop.metaobjects['highlights']['washable'].image.value }}\n```\n\n> Note:\n> When the [`publishable` capability](/apps/data-extensions/metaobjects/capabilities) is enabled, a metaobject can only be accessed if its status is `active`. If its status is `draft`, then the return value is `nil`.\n", + "description": "The access path for a metaobject consists of two layers:\n\n- type - The type of the parent metaobject definition.\n- handle - The unique [handle](/docs/api/liquid/basics#handles) of the metaobject.\n\nGiven this, you can access a metaobject with the following syntax:\n\n```liquid\n{{ shop.metaobjects.type.handle }}\n```\n\nYou can also use square bracket notation:\n\n```liquid\n{{ shop.metaobjects['type']['handle'] }}\n```\n\nA metaobjects's field values can be accessed using the key of the desired field:\n\n```liquid\n{{ shop.metaobjects.testimonials.homepage.title }}\n{{ shop.metaobjects['highlights']['washable'].image.value }}\n```\n\n> Note:\n> When the [`publishable` capability](/apps/data-extensions/metaobjects/capabilities) is enabled, a metaobject can only be accessed if its status is `active`. If its status is `draft`, then the return value is `nil`.\n", "syntax": "", "path": "", "raw_liquid": "", @@ -9039,7 +9039,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`model_viewer_tag` filter](/api/liquid/filters/model_viewer_tag) to output a [Google model viewer component](https://modelviewer.dev)\n> for the model.", + "description": "> Tip:\n> Use the [`model_viewer_tag` filter](/docs/api/liquid/filters/model_viewer_tag) to output a [Google model viewer component](https://modelviewer.dev)\n> for the model.", "properties": [ { "deprecated": false, @@ -9102,7 +9102,7 @@ "examples": [ { "name": "Filter for media of a specific type", - "description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n", + "description": "You 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", "syntax": "", "path": "/products/potion-bottle", "raw_liquid": "{% assign models = product.media | where: 'media_type', 'model' %}\n\n{% for model in models %}\n {{- model | model_viewer_tag }}\n{% endfor %}", @@ -9137,7 +9137,7 @@ "array_value": "" } ], - "summary": "The position of the model in the [`product.media`](/api/liquid/objects/product#product-media) array.", + "summary": "The position of the model in the [`product.media`](/docs/api/liquid/objects/product#product-media) array.", "name": "position" }, { @@ -9274,7 +9274,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "properties": [ { "deprecated": false, @@ -9345,7 +9345,7 @@ "properties": [ { "deprecated": true, - "deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `order.discounts` property has been replaced by [`order.discount_applications`](/api/liquid/objects/order#order-discount_applications).", + "deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `order.discounts` property has been replaced by [`order.discount_applications`](/docs/api/liquid/objects/order#order-discount_applications).", "description": "", "examples": [ @@ -9445,7 +9445,7 @@ "array_value": "" } ], - "summary": "The localized version of the [cancellation reason](/api/liquid/objects/order#order-cancel_reason) for the order.", + "summary": "The localized version of the [cancellation reason](/docs/api/liquid/objects/order#order-cancel_reason) for the order.", "name": "cancel_reason_label" }, { @@ -9469,7 +9469,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -9505,7 +9505,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -9523,7 +9523,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If there are no duties, then `nil` is returned. The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "If there are no duties, then `nil` is returned. The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -9595,7 +9595,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -9613,7 +9613,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The amount is calculated after refunds are applied, so is equal to `order.total_price` minus `order.total_refunded_amount`.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The amount is calculated after refunds are applied, so is equal to `order.total_price` minus `order.total_refunded_amount`.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -9631,7 +9631,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -9649,7 +9649,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -9758,7 +9758,7 @@ "return_type": [ ], - "summary": "The localized version of the [financial status](/api/liquid/objects/order#order-financial_status) of the order.", + "summary": "The localized version of the [financial status](/docs/api/liquid/objects/order#order-financial_status) of the order.", "name": "financial_status_label" }, { @@ -9818,7 +9818,7 @@ "array_value": "" } ], - "summary": "The localized version of the [fulfillment status](/api/liquid/objects/order#order-fulfillment_status) of the order.", + "summary": "The localized version of the [fulfillment status](/docs/api/liquid/objects/order#order-fulfillment_status) of the order.", "name": "fulfillment_status_label" }, { @@ -9854,7 +9854,7 @@ "array_value": "" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the order.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the order.", "name": "metafields" }, { @@ -9908,7 +9908,7 @@ "array_value": "" } ], - "summary": "The integer representation of the order [name](/api/liquid/objects/order#order-name).", + "summary": "The integer representation of the order [name](/docs/api/liquid/objects/order#order-name).", "name": "order_number" }, { @@ -10076,7 +10076,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> These line items are used to calculate the the [subtotal price](/api/liquid/objects/order#order-subtotal_price).", + "description": "> Note:\n> These line items are used to calculate the the [subtotal price](/docs/api/liquid/objects/order#order-subtotal_price).", "examples": [ ], @@ -10130,7 +10130,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -10148,7 +10148,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -10160,13 +10160,13 @@ "array_value": "" } ], - "summary": "The sum of the prices of the [subtotal line items](/api/liquid/objects/order#order-subtotal_line_items) in the currency's subunit, after any line item or\ncart discounts have been applied.", + "summary": "The sum of the prices of the [subtotal line items](/docs/api/liquid/objects/order#order-subtotal_line_items) in the currency's subunit, after any line item or\ncart discounts have been applied.", "name": "subtotal_price" }, { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> The total price is calculated before refunds are applied. Use [`order.total_net_amount`](/api/liquid/objects/order#order-total_net_amount)\n> to output the total minus any refunds.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "> Note:\n> The total price is calculated before refunds are applied. Use [`order.total_net_amount`](/docs/api/liquid/objects/order#order-total_net_amount)\n> to output the total minus any refunds.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -10184,7 +10184,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -10286,7 +10286,7 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the page.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the page.", "name": "handle" }, { @@ -10376,13 +10376,13 @@ "array_value": "" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the page.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the page.", "name": "metafields" }, { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -10424,7 +10424,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`default_pagination` filter](/api/liquid/filters/default_pagination) to output pagination links.", + "description": "> Tip:\n> Use the [`default_pagination` filter](/docs/api/liquid/filters/default_pagination) to output pagination links.", "properties": [ { "deprecated": false, @@ -10589,7 +10589,7 @@ "name": "page_param" } ], - "summary": "Information about the pagination inside a set of [`paginate` tags](/api/liquid/tags/paginate).", + "summary": "Information about the pagination inside a set of [`paginate` tags](/docs/api/liquid/tags/paginate).", "name": "paginate", "examples": [ @@ -10638,7 +10638,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "You can check whether any resources of a specific type were returned using the [`size` filter](/api/liquid/filters/size).\n\n```liquid\n{% if predictive_search.resources.articles.size > 0 %}\n {% for article in predictive_search.resources.articles %}\n {{ article.title }}\n {% endfor %}\n{% endif %}\n```", + "description": "You can check whether any resources of a specific type were returned using the [`size` filter](/docs/api/liquid/filters/size).\n\n```liquid\n{% if predictive_search.resources.articles.size > 0 %}\n {% for article in predictive_search.resources.articles %}\n {{ article.title }}\n {% endfor %}\n{% endif %}\n```", "examples": [ ], @@ -10656,7 +10656,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`highlight` filter](/api/liquid/filters/highlight) to highlight the search terms in search results content.", + "description": "> Tip:\n> Use the [`highlight` filter](/docs/api/liquid/filters/highlight) to highlight the search terms in search results content.", "examples": [ ], @@ -10674,7 +10674,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "Searches can be performed on the following object types:\n\n- [`article`](/api/liquid/objects/article)\n- [`collection`](/api/liquid/objects/collection)\n- [`page`](/api/liquid/objects/page)\n- [`product`](/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the [`types` query parameter](/api/ajax/reference/predictive-search#query-parameters).", + "description": "Searches can be performed on the following object types:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`page`](/docs/api/liquid/objects/page)\n- [`product`](/docs/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the [`types` query parameter](/api/ajax/reference/predictive-search#query-parameters).", "examples": [ ], @@ -10754,7 +10754,7 @@ "array_value": "" } ], - "summary": "The 1-based index of the price adjustment in the [`selling_plan.price_adjustments` array](/api/liquid/objects/selling_plan#selling_plan-price_adjustments).", + "summary": "The 1-based index of the price adjustment in the [`selling_plan.price_adjustments` array](/docs/api/liquid/objects/selling_plan#selling_plan-price_adjustments).", "name": "position" }, { @@ -10790,7 +10790,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "How this value is interpreted depends on the [value type](/api/liquid/objects/selling_plan_price_adjustment#selling_plan_price_adjustment-value_type) of\nthe price adjustment. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount that the original price is being adjusted by, in the currency's subunit. |\n| `percentage` | The percent amount that the original price is being adjusted by. |\n| `price` | The adjusted amount in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "How this value is interpreted depends on the [value type](/docs/api/liquid/objects/selling_plan_price_adjustment#selling_plan_price_adjustment-value_type) of\nthe price adjustment. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount that the original price is being adjusted by, in the currency's subunit. |\n| `percentage` | The percent amount that the original price is being adjusted by. |\n| `price` | The adjusted amount in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -10916,7 +10916,7 @@ "array_value": "" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the product.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the product.", "name": "metafields" }, { @@ -10988,7 +10988,7 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the product.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the product.", "name": "handle" }, { @@ -11030,7 +11030,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`product.content`](/api/liquid/objects/product#product-content).", + "description": "> Note:\n> This is the same value as [`product.content`](/docs/api/liquid/objects/product#product-content).", "examples": [ ], @@ -11048,7 +11048,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`product.description`](/api/liquid/objects/product#product-description).", + "description": "> Note:\n> This is the same value as [`product.description`](/docs/api/liquid/objects/product#product-description).", "examples": [ ], @@ -11084,7 +11084,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> You can use [media filters](/api/liquid/filters/media-filters) to output media URLs and displays. To learn about how\n> to include media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).", + "description": "> Tip:\n> You can use [media filters](/docs/api/liquid/filters/media-filters) to output media URLs and displays. To learn about how\n> to include media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).", "examples": [ ], @@ -11102,7 +11102,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> You can use [media filters](/api/liquid/filters/media-filters) to output media URLs and displays. To learn about how\n> to include media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).", + "description": "> Tip:\n> You can use [media filters](/docs/api/liquid/filters/media-filters) to output media URLs and displays. To learn about how\n> to include media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).", "examples": [ ], @@ -11120,7 +11120,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`product.price`](/api/liquid/objects/product#product-price).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "> Note:\n> This is the same value as [`product.price`](/docs/api/liquid/objects/product#product-price).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -11138,7 +11138,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`product.price_min`](/api/liquid/objects/product#product-price_min).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "> Note:\n> This is the same value as [`product.price_min`](/docs/api/liquid/objects/product#product-price_min).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -11156,7 +11156,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -11286,7 +11286,7 @@ "examples": [ { "name": "Output the options", - "description": "You can use the [`size` filter](/api/liquid/filters/size) with dot notation to determine how many options a product has.\n", + "description": "You can use the [`size` filter](/docs/api/liquid/filters/size) with dot notation to determine how many options a product has.\n", "syntax": "", "path": "/products/health-potion", "raw_liquid": "{% if product.options.size > 0 -%}\n {% for option in product.options -%}\n - {{ option }}\n {%- endfor %}\n{%- endif %}", @@ -11327,7 +11327,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -11345,7 +11345,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -11363,7 +11363,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -11435,7 +11435,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -11453,7 +11453,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -11492,7 +11492,7 @@ "array_value": "" } ], - "summary": "Allows you to access a specific [product option](/api/liquid/objects/product_option) by its name.", + "summary": "Allows you to access a specific [product option](/docs/api/liquid/objects/product_option) by its name.", "name": "options_by_name" }, { @@ -11516,7 +11516,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> A variant requires a selling plan if [`variant.requires_selling_plan`](/api/liquid/objects/variant#variant-requires_selling_plan)\n> is `true`.", + "description": "> Note:\n> A variant requires a selling plan if [`variant.requires_selling_plan`](/docs/api/liquid/objects/variant#variant-requires_selling_plan)\n> is `true`.", "examples": [ ], @@ -11686,7 +11686,7 @@ "array_value": "" } ], - "summary": "The 1-based index of the product option in the [`product.options_with_values` array](/api/liquid/objects/product#product-options_with_values).", + "summary": "The 1-based index of the product option in the [`product.options_with_values` array](/docs/api/liquid/objects/product#product-options_with_values).", "name": "position" }, { @@ -11788,7 +11788,7 @@ "array_value": "" } ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the variant.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the variant.", "name": "metafields" }, { @@ -11893,7 +11893,25 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "> Note:\n> The default quantity rule is `min=1,max=null,increment=1`.", + "examples": [ + + ], + "return_type": [ + { + "type": "quantity_rule", + "name": "", + "description": "", + "array_value": "" + } + ], + "summary": "Returns the specified quantity rule for the variant if one exists in the current customer context. Otherwise returns `min=1,max=nil,increment=1` if the variant does not have any quantity rule.", + "name": "quantity_rule" + }, + { + "deprecated": false, + "deprecation_reason": "", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -11911,7 +11929,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -12040,7 +12058,7 @@ "array_value": "" } ], - "summary": "The values of the variant for each [product option](/api/liquid/objects/product_option).", + "summary": "The values of the variant for each [product option](/docs/api/liquid/objects/product_option).", "name": "options" }, { @@ -12118,7 +12136,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> To output the weight of a variant in this unit, use this property, and the `variant.weight_in_unit` property, with the\n> [`weight_with_unit` filter](/api/liquid/filters/weight_with_unit).", + "description": "> Tip:\n> To output the weight of a variant in this unit, use this property, and the `variant.weight_in_unit` property, with the\n> [`weight_with_unit` filter](/docs/api/liquid/filters/weight_with_unit).", "examples": [ ], @@ -12136,7 +12154,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> To output this weight, use this property, and the `variant.weight_unit` property, with the [`weight_with_unit` filter](/api/liquid/filters/weight_with_unit).", + "description": "> Tip:\n> To output this weight, use this property, and the `variant.weight_unit` property, with the [`weight_with_unit` filter](/docs/api/liquid/filters/weight_with_unit).", "examples": [ ], @@ -12154,7 +12172,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`weight_with_unit` filter](/api/liquid/filters/weight_with_unit) filter to format the weight in\n> [the store's format](https://www.shopify.com/admin/settings/general).\n>\n> Use `variant.weight_in_unit` to output the weight in the unit configured on the variant.", + "description": "> Tip:\n> Use the [`weight_with_unit` filter](/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).\n>\n> Use `variant.weight_in_unit` to output the weight in the unit configured on the variant.", "examples": [ ], @@ -12190,7 +12208,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -12304,7 +12322,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`variant.image`](/api/liquid/objects/variant#variant-image).", + "description": "> Note:\n> This is the same value as [`variant.image`](/docs/api/liquid/objects/variant#variant-image).", "examples": [ ], @@ -12322,7 +12340,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Note:\n> This is the same value as [`variant.featured_image`](/api/liquid/objects/variant#variant-featured_image).", + "description": "> Note:\n> This is the same value as [`variant.featured_image`](/docs/api/liquid/objects/variant#variant-featured_image).", "examples": [ ], @@ -12376,7 +12394,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "Incoming inventory information is populated by [inventory transfers](https://help.shopify.com/manual/products/inventory/transfers).\n\n> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the date.", + "description": "Incoming inventory information is populated by [inventory transfers](https://help.shopify.com/manual/products/inventory/transfers).\n\n> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the date.", "examples": [ ], @@ -12563,7 +12581,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If `performed?` is `false`, then an [EmptyDrop](/api/liquid/basics#emptydrop) is returned.", + "description": "If `performed?` is `false`, then an [EmptyDrop](/docs/api/liquid/basics#emptydrop) is returned.", "examples": [ ], @@ -13516,7 +13534,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`highlight` filter](/api/liquid/filters/highlight) to highlight the search terms in search result content.", + "description": "> Tip:\n> Use the [`highlight` filter](/docs/api/liquid/filters/highlight) to highlight the search terms in search result content.", "examples": [ ], @@ -13570,7 +13588,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "An item can be an [`article`](/api/liquid/objects/article), a [`page`](/api/liquid/objects/page), or a\n[`product`](/api/liquid/objects/product).\n\n> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many results to show per page, up to a limit of 50.", + "description": "An item can be an [`article`](/docs/api/liquid/objects/article), a [`page`](/docs/api/liquid/objects/page), or a\n[`product`](/docs/api/liquid/objects/product).\n\n> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many results to show per page, up to a limit of 50.", "examples": [ { "name": "Search result `object_type`", @@ -13673,7 +13691,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "A search can be performed on the following object types:\n\n- [`article`](/api/liquid/objects/article)\n- [`page`](/api/liquid/objects/page)\n- [`product`](/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the `types` URL parameter.", + "description": "A search can be performed on the following object types:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`page`](/docs/api/liquid/objects/page)\n- [`product`](/docs/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the `types` URL parameter.", "examples": [ ], @@ -13822,7 +13840,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -13840,7 +13858,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value of the **compare at** price is the line item's price without the selling plan applied. If the price and compare\nat price are equal, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value of the **compare at** price is the line item's price without the selling plan applied. If the price and compare\nat price are equal, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -13858,7 +13876,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The maximum length of the array is two. If the associated selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_allocation_price_adjustment` maps to a [`selling_plan_price_adjustment`](/api/liquid/objects/selling_plan_price_adjustment)\nin the [`selling_plan.price_adjustments` array](/api/liquid/objects/selling_plan#selling_plan-price_adjustments). The\n`selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` array contains the resulting money amounts.", + "description": "The maximum length of the array is two. If the associated selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_allocation_price_adjustment` maps to a [`selling_plan_price_adjustment`](/docs/api/liquid/objects/selling_plan_price_adjustment)\nin the [`selling_plan.price_adjustments` array](/docs/api/liquid/objects/selling_plan#selling_plan-price_adjustments). The\n`selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` array contains the resulting money amounts.", "examples": [ ], @@ -13876,7 +13894,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If the variant doesn't have a unit price, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "If the variant doesn't have a unit price, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -13888,13 +13906,13 @@ "array_value": "" } ], - "summary": "The [unit price](/api/liquid/objects/variant#variant-unit_price) of the variant associated with the selling plan, in the currency's subunit.", + "summary": "The [unit price](/docs/api/liquid/objects/variant#variant-unit_price) of the variant associated with the selling plan, in the currency's subunit.", "name": "unit_price" }, { "deprecated": false, "deprecation_reason": "", - "description": "If a selling plan includes multiple deliveries, then the `per_delivery_price` is the `price` divided by the number of\ndeliveries.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "If a selling plan includes multiple deliveries, then the `per_delivery_price` is the `price` divided by the number of\ndeliveries.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -13942,13 +13960,13 @@ "array_value": "" } ], - "summary": "The ID of the [`selling_plan_group`](/api/liquid/objects/selling_plan_group) that the selling plan of the allocation belongs to.", + "summary": "The ID of the [`selling_plan_group`](/docs/api/liquid/objects/selling_plan_group) that the selling plan of the allocation belongs to.", "name": "selling_plan_group_id" }, { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -13966,7 +13984,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -14028,13 +14046,13 @@ "array_value": "" } ], - "summary": "The 1-based index of the price adjustment in the\n[`selling_plan_allocation.price_adjustments` array](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).", + "summary": "The 1-based index of the price adjustment in the\n[`selling_plan_allocation.price_adjustments` array](/docs/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).", "name": "position" }, { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -14050,7 +14068,7 @@ "name": "price" } ], - "summary": "The resulting price from the intent of the associated [`selling_plan_price_adjustment`](/api/liquid/objects/selling_plan_price_adjustment).", + "summary": "The resulting price from the intent of the associated [`selling_plan_price_adjustment`](/docs/api/liquid/objects/selling_plan_price_adjustment).", "name": "selling_plan_allocation_price_adjustment", "examples": [ @@ -14116,7 +14134,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "How this value is interpreted depends on the [value type](/api/liquid/objects/selling_plan_checkout_charge#selling_plan_checkout_charge-value_type) of\nthe checkout charge. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `percentage` | The percent amount of the original price that the customer needs to pay.<br><br>For example, if the value is 50, then the customer needs to pay 50% of the original price. |\n| `price` | The amount that the customer needs to pay in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "How this value is interpreted depends on the [value type](/docs/api/liquid/objects/selling_plan_checkout_charge#selling_plan_checkout_charge-value_type) of\nthe checkout charge. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `percentage` | The percent amount of the original price that the customer needs to pay.<br><br>For example, if the value is 50, then the customer needs to pay 50% of the original price. |\n| `price` | The amount that the customer needs to pay in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -14244,7 +14262,7 @@ "array_value": "" } ], - "summary": "The ID of the [`selling_plan_group`](/api/liquid/objects/selling_plan_group) that the selling plan belongs to.", + "summary": "The ID of the [`selling_plan_group`](/docs/api/liquid/objects/selling_plan_group) that the selling plan belongs to.", "name": "group_id" }, { @@ -14286,7 +14304,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The maximum length of the array is two. If the selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_price_adjustment` maps to a [`selling_plan_allocation_price_adjustment`](/api/liquid/objects/selling_plan_allocation_price_adjustment)\nin the [`selling_plan_allocation.price_adjustments` array](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).\nThe `selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` contains the resulting money amounts.", + "description": "The maximum length of the array is two. If the selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_price_adjustment` maps to a [`selling_plan_allocation_price_adjustment`](/docs/api/liquid/objects/selling_plan_allocation_price_adjustment)\nin the [`selling_plan_allocation.price_adjustments` array](/docs/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).\nThe `selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` contains the resulting money amounts.", "examples": [ ], @@ -14367,7 +14385,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "Selling plans are grouped based on shared [selling plan option names](/api/liquid/objects/selling_plan_option#selling_plan_option-name).\n\nTo learn about how to support selling plans in your theme, refer to [Purchase options](/themes/pricing-payments/purchase-options).", + "description": "Selling plans are grouped based on shared [selling plan option names](/docs/api/liquid/objects/selling_plan_option#selling_plan_option-name).\n\nTo learn about how to support selling plans in your theme, refer to [Purchase options](/themes/pricing-payments/purchase-options).", "properties": [ { "deprecated": false, @@ -14426,7 +14444,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "If the app doesn't provide a value, then `nil` is returned.\n\n> Tip:\n> You can use this property, with the [`where` filter](/api/liquid/filters/where), to filter the\n> [`product.selling_plan_groups` array](/api/liquid/objects/product#product-selling_plan_groups) for all selling plan groups\n> from a specific app.", + "description": "If the app doesn't provide a value, then `nil` is returned.\n\n> Tip:\n> You can use this property, with the [`where` filter](/docs/api/liquid/filters/where), to filter the\n> [`product.selling_plan_groups` array](/docs/api/liquid/objects/product#product-selling_plan_groups) for all selling plan groups\n> from a specific app.", "examples": [ ], @@ -14542,7 +14560,7 @@ "array_value": "" } ], - "summary": "The 1-based index of the option in the [`selling_plan_group.options` array](/api/liquid/objects/selling_plan_group#selling_plan_group-options).", + "summary": "The 1-based index of the option in the [`selling_plan_group.options` array](/docs/api/liquid/objects/selling_plan_group#selling_plan_group-options).", "name": "position" }, { @@ -14582,7 +14600,7 @@ "name": "selected_value" } ], - "summary": "Information about a specific option in a [selling plan group](/api/liquid/objects/selling_plan_group).", + "summary": "Information about a specific option in a [selling plan group](/docs/api/liquid/objects/selling_plan_group).", "name": "selling_plan_group_option", "examples": [ @@ -14646,13 +14664,13 @@ "array_value": "" } ], - "summary": "The 1-based index of the selling plan option in the associated [`selling_plan_group.options` array](/api/liquid/objects/selling_plan_group#selling_plan_group-options).", + "summary": "The 1-based index of the selling plan option in the associated [`selling_plan_group.options` array](/docs/api/liquid/objects/selling_plan_group#selling_plan_group-options).", "name": "position" }, { "deprecated": false, "deprecation_reason": "", - "description": "The value is one of the [`selling_plan_group_option.values`](/api/liquid/objects/selling_plan_group_option#selling_plan_group_option-values).", + "description": "The value is one of the [`selling_plan_group_option.values`](/docs/api/liquid/objects/selling_plan_group_option#selling_plan_group_option-values).", "examples": [ ], @@ -14668,7 +14686,7 @@ "name": "value" } ], - "summary": "Information about a selling plan's value for a specific [`selling_plan_group_option`](/api/liquid/objects/selling_plan_group_option).", + "summary": "Information about a selling plan's value for a specific [`selling_plan_group_option`](/docs/api/liquid/objects/selling_plan_group_option).", "name": "selling_plan_option", "examples": [ @@ -14706,7 +14724,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "In most contexts, the shipping method title appears in the customer's preferred language. However, in the context of an\n[order](/api/liquid/objects/order), the shipping method title appears in the language that the customer checked out in.", + "description": "In most contexts, the shipping method title appears in the customer's preferred language. However, in the context of an\n[order](/docs/api/liquid/objects/order), the shipping method title appears in the language that the customer checked out in.", "examples": [ ], @@ -14724,7 +14742,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -14742,7 +14760,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -14772,7 +14790,7 @@ "array_value": "" } ], - "summary": "The [handle](/api/liquid/basics#handles) of the shipping method.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the shipping method.", "name": "handle" }, { @@ -14915,7 +14933,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> You can get the store's currency with [`shop.currency`](/api/liquid/objects/shop#shop-currency).", + "description": "> Tip:\n> You can get the store's currency with [`shop.currency`](/docs/api/liquid/objects/shop#shop-currency).", "examples": [ ], @@ -14950,7 +14968,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because the name didn't make it clear that the returned locales were published.\n\nThe `shop.enabled_locales` property has been replaced by [`shop.published_locales`](/api/liquid/objects/shop#shop-published_locales).", + "deprecation_reason": "Deprecated because the name didn't make it clear that the returned locales were published.\n\nThe `shop.enabled_locales` property has been replaced by [`shop.published_locales`](/docs/api/liquid/objects/shop#shop-published_locales).", "description": "", "examples": [ @@ -14974,7 +14992,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because this value is contextual to the request and not a property of the shop resource.\n\nThe `shop.locale` property has been replaced by [request.locale](/api/liquid/objects/request#request-locale).", + "deprecation_reason": "Deprecated because this value is contextual to the request and not a property of the shop resource.\n\nThe `shop.locale` property has been replaced by [request.locale](/docs/api/liquid/objects/request#request-locale).", "description": "", "examples": [ @@ -15234,13 +15252,13 @@ "return_type": [ ], - "summary": "The [metafields](/api/liquid/objects/metafield) applied to the store.", + "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the store.", "name": "metafields" }, { "deprecated": false, "deprecation_reason": "", - "description": "The payment types are based on the store's enabled [payment providers](https://help.shopify.com/manual/payments) and\nthe customer's current region and currency.\n\n> Tip:\n> You can output an `svg` logo for each payment type with the [`payment_type_svg_tag` filter](/api/liquid/filters/payment_type_svg_tag).\n> Alternatively, you can get the source URL for each `svg` with the [`payment_type_img_url` filter](/api/liquid/filters/payment_type_img_url).", + "description": "The payment types are based on the store's enabled [payment providers](https://help.shopify.com/manual/payments) and\nthe customer's current region and currency.\n\n> Tip:\n> You can output an `svg` logo for each payment type with the [`payment_type_svg_tag` filter](/docs/api/liquid/filters/payment_type_svg_tag).\n> Alternatively, you can get the source URL for each `svg` with the [`payment_type_img_url` filter](/docs/api/liquid/filters/payment_type_img_url).", "examples": [ ], @@ -15257,7 +15275,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because whether or not prices have taxes included is dependent on the customer's country.\n\nThe `shop.taxes_included` property has been replaced by [cart.taxes_included](/api/liquid/objects/cart#cart-taxes_included).", + "deprecation_reason": "Deprecated because whether or not prices have taxes included is dependent on the customer's country.\n\nThe `shop.taxes_included` property has been replaced by [cart.taxes_included](/docs/api/liquid/objects/cart#cart-taxes_included).", "description": "", "examples": [ @@ -15501,14 +15519,14 @@ { "deprecated": false, "deprecation_reason": "", - "description": "Metaobjects can only be accessed by specifying their type and handle. For more information, refer to [Access metaobjects individually](/api/liquid/objects#metaobject-access-metaobjects-individually).\n\nMetaobjects are created in the [Content](https://www.shopify.com/admin/content) page of the Shopify admin.", + "description": "Metaobjects can only be accessed by specifying their type and handle. For more information, refer to [Access metaobjects individually](/docs/api/liquid/objects#metaobject-access-metaobjects-individually).\n\nMetaobjects are created in the [Content](https://www.shopify.com/admin/content) page of the Shopify admin.", "examples": [ ], "return_type": [ ], - "summary": "All of the [metaobjects](/api/liquid/objects/metaobject) of the store.", + "summary": "All of the [metaobjects](/docs/api/liquid/objects/metaobject) of the store.", "name": "metaobjects" } ], @@ -15934,7 +15952,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", "examples": [ ], @@ -16427,7 +16445,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -16517,7 +16535,7 @@ "array_value": "" } ], - "summary": "The [handleized](/api/liquid/basics#modifying-handles) name of the payment provider used for the transaction.", + "summary": "The [handleized](/docs/api/liquid/basics#modifying-handles) name of the payment provider used for the transaction.", "name": "gateway" }, { @@ -16559,7 +16577,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The amount is in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The amount is in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -16745,7 +16763,7 @@ "array_value": "" } ], - "summary": "The unit of measurement used to measure the [`quantity_value`](/api/liquid/objects/unit_price_measurement#unit_price_measurement-quantity_value).", + "summary": "The unit of measurement used to measure the [`quantity_value`](/docs/api/liquid/objects/unit_price_measurement#unit_price_measurement-quantity_value).", "name": "quantity_unit" }, { @@ -16781,7 +16799,7 @@ "array_value": "" } ], - "summary": "The unit of measurement used to measure the [`reference_value`](/api/liquid/objects/unit_price_measurement#unit_price_measurement-reference_value).", + "summary": "The unit of measurement used to measure the [`reference_value`](/docs/api/liquid/objects/unit_price_measurement#unit_price_measurement-reference_value).", "name": "reference_unit" } ], @@ -16994,7 +17012,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`video_tag` filter](/api/liquid/filters/video_tag) to output the video in an HTML `<video>` tag.", + "description": "> Tip:\n> Use the [`video_tag` filter](/docs/api/liquid/filters/video_tag) to output the video in an HTML `<video>` tag.", "properties": [ { "deprecated": false, @@ -17093,7 +17111,7 @@ "examples": [ { "name": "Filter for media of a specific type", - "description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n", + "description": "You 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", "syntax": "", "path": "/products/potion-beats", "raw_liquid": "{% assign videos = product.media | where: 'media_type', 'video' %}\n\n{% for video in videos %}\n {{- video | video_tag }}\n{% endfor %}", @@ -17128,7 +17146,7 @@ "array_value": "" } ], - "summary": "The position of the video in the [`product.media`](/api/liquid/objects/product#product-media) array.", + "summary": "The position of the video in the [`product.media`](/docs/api/liquid/objects/product#product-media) array.", "name": "position" }, { @@ -17150,7 +17168,7 @@ "name": "preview_image" } ], - "summary": "Information about a video uploaded as [product media](/api/liquid/objects/product-media) or a [`file_reference` metafield](/apps/metafields/types).", + "summary": "Information about a video uploaded as [product media](/docs/api/liquid/objects/product-media) or a [`file_reference` metafield](/apps/metafields/types).", "name": "video", "examples": [ @@ -17310,7 +17328,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "Use `additional_checkout_buttons` to check whether these payment providers exist, and\n[`content_for_additional_checkout_buttons`](/api/liquid/objects/content_for_additional_checkout_buttons)\nto show the associated checkout buttons. To learn more about how to use these objects, refer to\n[Accelerated checkout](/themes/pricing-payments/accelerated-checkout).\n\n```liquid\n{% if additional_checkout_buttons %}\n {{ content_for_additional_checkout_buttons }}\n{% endif %}\n```", + "description": "Use `additional_checkout_buttons` to check whether these payment providers exist, and\n[`content_for_additional_checkout_buttons`](/docs/api/liquid/objects/content_for_additional_checkout_buttons)\nto show the associated checkout buttons. To learn more about how to use these objects, refer to\n[Accelerated checkout](/themes/pricing-payments/accelerated-checkout).\n\n```liquid\n{% if additional_checkout_buttons %}\n {{ content_for_additional_checkout_buttons }}\n{% endif %}\n```", "properties": [ ], @@ -17345,7 +17363,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "An attribute called `data-provinces` is set for each `<option>`, and contains a JSON-encoded array of the\ncountry or region's subregions. If a country doesn't have any subregions, then an empty array is set for\nits `data-provinces` attribute.\n\n> Tip:\n> To return only the countries and regions included in the store's shipping zones, use the [`country_option_tags` object](/api/liquid/objects/country_option_tags).", + "description": "An attribute called `data-provinces` is set for each `<option>`, and contains a JSON-encoded array of the\ncountry or region's subregions. If a country doesn't have any subregions, then an empty array is set for\nits `data-provinces` attribute.\n\n> Tip:\n> To return only the countries and regions included in the store's shipping zones, use the [`country_option_tags` object](/docs/api/liquid/objects/country_option_tags).", "properties": [ ], @@ -17459,7 +17477,7 @@ "array_value": "" } ], - "summary": "Additional attributes entered by the customer with the [cart](/api/liquid/objects/cart#cart-attributes).", + "summary": "Additional attributes entered by the customer with the [cart](/docs/api/liquid/objects/cart#cart-attributes).", "name": "attributes" }, { @@ -17590,7 +17608,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `checkout.discounts` property has been replaced by [`checkout.discount_applications`](/api/liquid/objects/checkout#checkout-discount_applications).", + "deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `checkout.discounts` property has been replaced by [`checkout.discount_applications`](/docs/api/liquid/objects/checkout#checkout-discount_applications).", "description": "", "examples": [ @@ -17627,7 +17645,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -17645,7 +17663,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -17753,7 +17771,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -17807,7 +17825,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -17825,7 +17843,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This value is the same as [`checkout.id`](/api/liquid/objects/checkout#checkout-id) with a `#` prepended to it.", + "description": "This value is the same as [`checkout.id`](/docs/api/liquid/objects/checkout#checkout-id) with a `#` prepended to it.", "examples": [ ], @@ -17855,7 +17873,7 @@ "array_value": "" } ], - "summary": "Additional information entered by the customer with the [cart](/api/liquid/objects/cart#cart-note).", + "summary": "Additional information entered by the customer with the [cart](/docs/api/liquid/objects/cart#cart-note).", "name": "note" }, { @@ -17879,7 +17897,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is the same as [`order.id`](/api/liquid/objects/order#order-id).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.", + "description": "The value is the same as [`order.id`](/docs/api/liquid/objects/order#order-id).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.", "examples": [ ], @@ -17897,7 +17915,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is the same as [`order.name`](/api/liquid/objects/order#order-name).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.", + "description": "The value is the same as [`order.name`](/docs/api/liquid/objects/order#order-name).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.", "examples": [ ], @@ -17915,7 +17933,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is the same as [`order.order_number`](/api/liquid/objects/order#order-order_number).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.", + "description": "The value is the same as [`order.order_number`](/docs/api/liquid/objects/order#order-order_number).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.", "examples": [ ], @@ -17987,7 +18005,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -18023,7 +18041,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -18041,7 +18059,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.", + "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", "examples": [ ], @@ -18094,7 +18112,7 @@ }, { "deprecated": true, - "deprecation_reason": "Deprecated because the array is always the same as [`checkout.line_items`](/api/liquid/objects/checkout#checkout-line_items).", + "deprecation_reason": "Deprecated because the array is always the same as [`checkout.line_items`](/docs/api/liquid/objects/checkout#checkout-line_items).", "description": "", "examples": [ @@ -18181,7 +18199,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -18235,7 +18253,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "Outside of the Liquid context, the status of a comment can vary based on spam detection and whether blog comments are\nmoderated. However, only comments with a status of `published` are included in the [`article.comments` array](/api/liquid/objects/article#article-comments).\n\n> Tip:\n> To learn more about blog comments, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/blogs/managing-comments).", + "description": "Outside of the Liquid context, the status of a comment can vary based on spam detection and whether blog comments are\nmoderated. However, only comments with a status of `published` are included in the [`article.comments` array](/docs/api/liquid/objects/article#article-comments).\n\n> Tip:\n> To learn more about blog comments, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/blogs/managing-comments).", "examples": [ ], @@ -18253,7 +18271,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.", + "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", "examples": [ ], @@ -18283,7 +18301,7 @@ "array_value": "" } ], - "summary": "The relative URL of the article that the comment is associated with, with [`comment.id`](/api/liquid/objects/comment#comment-id)\nappended.", + "summary": "The relative URL of the article that the comment is associated with, with [`comment.id`](/docs/api/liquid/objects/comment#comment-id)\nappended.", "name": "url" } ], @@ -18313,7 +18331,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "Use [`additional_checkout_buttons`](/api/liquid/objects/additional_checkout_buttons)\nto check whether these payment providers exist, and `content_for_additional_checkout_buttons`\nto show the associated checkout buttons. To learn more about how to use these objects, refer to\n[Accelerated checkout](/themes/pricing-payments/accelerated-checkout).\n\n```liquid\n{% if additional_checkout_buttons %}\n {{ content_for_additional_checkout_buttons }}\n{% endif %}\n```", + "description": "Use [`additional_checkout_buttons`](/docs/api/liquid/objects/additional_checkout_buttons)\nto check whether these payment providers exist, and `content_for_additional_checkout_buttons`\nto show the associated checkout buttons. To learn more about how to use these objects, refer to\n[Accelerated checkout](/themes/pricing-payments/accelerated-checkout).\n\n```liquid\n{% if additional_checkout_buttons %}\n {{ content_for_additional_checkout_buttons }}\n{% endif %}\n```", "properties": [ ], @@ -18418,7 +18436,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "An attribute called `data-provinces` is set for each `<option>`, and contains a JSON-encoded array of the\ncountry or region's subregions. If a country doesn't have any subregions, then an empty array is set for its\n`data-provinces` attribute.\n\n> Tip:\n> To return all countries and regions included in the store's shipping zones, use [`all_country_option_tags`](/api/liquid/objects/all_country_option_tags).", + "description": "An attribute called `data-provinces` is set for each `<option>`, and contains a JSON-encoded array of the\ncountry or region's subregions. If a country doesn't have any subregions, then an empty array is set for its\n`data-provinces` attribute.\n\n> Tip:\n> To return all countries and regions included in the store's shipping zones, use [`all_country_option_tags`](/docs/api/liquid/objects/all_country_option_tags).", "properties": [ ], @@ -18584,7 +18602,7 @@ "name": "translated_fields" } ], - "summary": "The error category strings for errors from a form created by a [`form` tag](/api/liquid/tags/form).", + "summary": "The error category strings for errors from a form created by a [`form` tag](/docs/api/liquid/tags/form).", "name": "form_errors", "examples": [ { @@ -18628,7 +18646,7 @@ "properties": [ ], - "summary": "The [handle](/api/liquid/basics#handles) of the resource associated with the current template.", + "summary": "The [handle](/docs/api/liquid/basics#handles) of the resource associated with the current template.", "name": "handle", "examples": [ @@ -18849,7 +18867,7 @@ "examples": [ { "name": "Create pagination navigation with `part`", - "description": "You can create a pagination navigation by iterating over each `part` of a [`paginate` object](/api/liquid/objects/paginate).\n", + "description": "You can create a pagination navigation by iterating over each `part` of a [`paginate` object](/docs/api/liquid/objects/paginate).\n", "syntax": "", "path": "/collections/all", "raw_liquid": "{% paginate collection.products by 5 -%}\n {% for part in paginate.parts -%}\n {% if part.is_link -%}\n {{ part.title | link_to: part.url}}\n {%- else -%}\n <span>{{ part.title }}</span>\n {% endif %}\n {%- endfor %}\n{%- endpaginate %}", @@ -18989,7 +19007,7 @@ }, "deprecated": false, "deprecation_reason": "", - "description": "You can check whether any resources of a specific type were returned using the [`size` filter](/api/liquid/filters/size).\n\n```liquid\n{% if predictive_search.resources.articles.size > 0 %}\n {% for article in predictive_search.resources.articles %}\n {{ article.title }}\n {% endfor %}\n{% endif %}\n```", + "description": "You can check whether any resources of a specific type were returned using the [`size` filter](/docs/api/liquid/filters/size).\n\n```liquid\n{% if predictive_search.resources.articles.size > 0 %}\n {% for article in predictive_search.resources.articles %}\n {{ article.title }}\n {% endfor %}\n{% endif %}\n```", "properties": [ { "deprecated": false, @@ -19078,6 +19096,101 @@ ] }, + { + "access": { + "global": false, + "parents": [ + { + "object": "variant", + "property": "quantity_rule" + } + ], + "template": [ + + ] + }, + "deprecated": false, + "deprecation_reason": "", + "description": "", + "properties": [ + { + "deprecated": false, + "deprecation_reason": "", + "description": "", + "examples": [ + + ], + "return_type": [ + { + "type": "number", + "name": "", + "description": "", + "array_value": "" + } + ], + "summary": "Minimum order quantity (default 1)", + "name": "min" + }, + { + "deprecated": false, + "deprecation_reason": "", + "description": "If there is no maximum, then `nil` is returned.", + "examples": [ + + ], + "return_type": [ + { + "type": "number", + "name": "", + "description": "", + "array_value": "" + } + ], + "summary": "Maximum order quantity", + "name": "max" + }, + { + "deprecated": false, + "deprecation_reason": "", + "description": "", + "examples": [ + + ], + "return_type": [ + { + "type": "number", + "name": "", + "description": "", + "array_value": "" + } + ], + "summary": "Order quantity increment (default 1)", + "name": "increment" + } + ], + "summary": "A variant order quantity rule (minimum, maximum, and increment). The default order variant quantity rule is `min=1,max=null,increment=1`.", + "name": "quantity_rule", + "examples": [ + { + "name": "The variant order quantity rule", + "description": "", + "syntax": "", + "path": "/products/health-potion", + "raw_liquid": "{{ product.variants.first.quantity_rule }}", + "parameter": false, + "display_type": "text", + "show_data_tab": true + } + ], + "json_data": { + "path": "", + "handle": "", + "data_from_file": "{\"min\":\"1\",\"max\":null,\"increment\":\"1\"}" + }, + "return_type": [ + + ] + }, { "access": { "global": true, @@ -19244,7 +19357,7 @@ { "deprecated": false, "deprecation_reason": "", - "description": "This value is used when assigning the [`collection.sort_by`](/api/liquid/objects/collection#collection-sort_by) and\n[`search.sort_by`](/api/liquid/objects/search#search-sort_by) parameters.", + "description": "This value is used when assigning the [`collection.sort_by`](/docs/api/liquid/objects/collection#collection-sort_by) and\n[`search.sort_by`](/docs/api/liquid/objects/search#search-sort_by) parameters.", "examples": [ ], @@ -19446,4 +19559,4 @@ ] } -] \ No newline at end of file +] diff --git a/data/tags.json b/data/tags.json index 5c28918..efecce1 100644 --- a/data/tags.json +++ b/data/tags.json @@ -3,7 +3,7 @@ "category": "html", "deprecated": false, "deprecation_reason": "", - "description": "Because there are many different form types available in Shopify themes, the `form` tag requires a type. Depending on the\nform type, an additional parameter might be required. You can specify the following form types:\n\n- [`activate_customer_password`](/api/liquid/tags/form#form-activate_customer_password)\n- [`cart`](/api/liquid/tags/form#form-cart)\n- [`contact`](/api/liquid/tags/form#form-contact)\n- [`create_customer`](/api/liquid/tags/form#form-create_customer)\n- [`currency`](/api/liquid/tags/form#form-currency)\n- [`customer`](/api/liquid/tags/form#form-customer)\n- [`customer_address`](/api/liquid/tags/form#form-customer_address)\n- [`customer_login`](/api/liquid/tags/form#form-customer_login)\n- [`guest_login`](/api/liquid/tags/form#form-guest_login)\n- [`localization`](/api/liquid/tags/form#form-localization)\n- [`new_comment`](/api/liquid/tags/form#form-new_comment)\n- [`product`](/api/liquid/tags/form#form-product)\n- [`recover_customer_password`](/api/liquid/tags/form#form-recover_customer_password)\n- [`reset_customer_password`](/api/liquid/tags/form#form-reset_customer_password)\n- [`storefront_password`](/api/liquid/tags/form#form-storefront_password)", + "description": "Because there are many different form types available in Shopify themes, the `form` tag requires a type. Depending on the\nform type, an additional parameter might be required. You can specify the following form types:\n\n- [`activate_customer_password`](/docs/api/liquid/tags/form#form-activate_customer_password)\n- [`cart`](/docs/api/liquid/tags/form#form-cart)\n- [`contact`](/docs/api/liquid/tags/form#form-contact)\n- [`create_customer`](/docs/api/liquid/tags/form#form-create_customer)\n- [`currency`](/docs/api/liquid/tags/form#form-currency)\n- [`customer`](/docs/api/liquid/tags/form#form-customer)\n- [`customer_address`](/docs/api/liquid/tags/form#form-customer_address)\n- [`customer_login`](/docs/api/liquid/tags/form#form-customer_login)\n- [`guest_login`](/docs/api/liquid/tags/form#form-guest_login)\n- [`localization`](/docs/api/liquid/tags/form#form-localization)\n- [`new_comment`](/docs/api/liquid/tags/form#form-new_comment)\n- [`product`](/docs/api/liquid/tags/form#form-product)\n- [`recover_customer_password`](/docs/api/liquid/tags/form#form-recover_customer_password)\n- [`reset_customer_password`](/docs/api/liquid/tags/form#form-reset_customer_password)\n- [`storefront_password`](/docs/api/liquid/tags/form#form-storefront_password)", "parameters": [ { "description": "The desired URL to redirect to when the form submits.", @@ -40,7 +40,7 @@ }, { "name": "cart", - "description": "Generates a form for creating a checkout based on the items currently in the cart. The `cart` form requires a [`cart` object](/api/liquid/objects/cart) as a parameter.\nTo learn more about using the cart form in your theme, refer to the [`cart` template](/themes/architecture/templates/cart#proceed-to-checkout).\n", + "description": "Generates a form for creating a checkout based on the items currently in the cart. The `cart` form requires a [`cart` object](/docs/api/liquid/objects/cart) as a parameter.\nTo learn more about using the cart form in your theme, refer to the [`cart` template](/themes/architecture/templates/cart#proceed-to-checkout).\n", "syntax": "{% form 'cart', cart %}\n form_content\n{% endform %}\n", "path": "/", "raw_liquid": "{% form 'cart', cart %}\n <!-- form content -->\n{% endform %}", @@ -70,7 +70,7 @@ }, { "name": "currency", - "description": "> Deprecated:\n> The `currency` form is deprecated and has been replaced by the [`localization` form](/api/liquid/tags/form#form-localization).\n\nGenerates a form for customers to select their preferred currency.\n\n> Tip:\n> Use the [`currency_selector` filter](/api/liquid/filters/currency_selector) to include a currency selector inside the form.\n", + "description": "> Deprecated:\n> The `currency` form is deprecated and has been replaced by the [`localization` form](/docs/api/liquid/tags/form#form-localization).\n\nGenerates a form for customers to select their preferred currency.\n\n> Tip:\n> Use the [`currency_selector` filter](/docs/api/liquid/filters/currency_selector) to include a currency selector inside the form.\n", "syntax": "{% form 'currency' %}\n form_content\n{% endform %}\n", "path": "/", "raw_liquid": "{% form 'currency' %}\n {{ form | currency_selector }}\n{% endform %}", @@ -80,7 +80,7 @@ }, { "name": "customer", - "description": "Generates a form for creating a new customer without registering a new account. This form is useful for collecting customer information when you don't want customers to log in to your store, such as building a list of emails from a newsletter signup.\n\n> Tip:\n> To generate a form that registers a customer account, use the [`create_customer` form](/api/liquid/tags/form#form-create_customer).\n\nTo learn more about using this form, and its contents, refer to [Email consent](/themes/customer-engagement/email-consent#newsletter-sign-up-form).\n", + "description": "Generates a form for creating a new customer without registering a new account. This form is useful for collecting customer information when you don't want customers to log in to your store, such as building a list of emails from a newsletter signup.\n\n> Tip:\n> To generate a form that registers a customer account, use the [`create_customer` form](/docs/api/liquid/tags/form#form-create_customer).\n\nTo learn more about using this form, and its contents, refer to [Email consent](/themes/customer-engagement/email-consent#newsletter-sign-up-form).\n", "syntax": "{% form 'customer' %}\n form_content\n{% endform %}\n", "path": "/", "raw_liquid": "{% form 'customer' %}\n <!-- form content -->\n{% endform %}", @@ -120,7 +120,7 @@ }, { "name": "localization", - "description": "Generates a form for customers to select their preferred country so that they're shown the appropriate language and currency. The `localization` form can contain one of two selectors:\n\n- A country selector\n- A language selector\n\n> Note:\n> The `localization` form replaces the deprecated [`currency` form](/api/liquid/tags/form#form-currency).\n\nTo learn more about using this form, and its contents, refer to [Support multiple currencies and languages](/themes/internationalization/multiple-currencies-languages).\n", + "description": "Generates a form for customers to select their preferred country so that they're shown the appropriate language and currency. The `localization` form can contain one of two selectors:\n\n- A country selector\n- A language selector\n\n> Note:\n> The `localization` form replaces the deprecated [`currency` form](/docs/api/liquid/tags/form#form-currency).\n\nTo learn more about using this form, and its contents, refer to [Support multiple currencies and languages](/themes/internationalization/multiple-currencies-languages).\n", "syntax": "{% form 'localization' %}\n form_content\n{% endform %}\n", "path": "/", "raw_liquid": "{% form 'localization' %}\n <!-- form content -->\n{% endform %}", @@ -130,7 +130,7 @@ }, { "name": "new_comment", - "description": "Generates a form for creating a new comment on an article. The `new_comment` form requires an [`article` object](/api/liquid/objects/article) as a parameter.\nTo learn more about using this form, and its contents, refer to the [`article` template](/themes/architecture/templates/article#the-comment-form).\n", + "description": "Generates a form for creating a new comment on an article. The `new_comment` form requires an [`article` object](/docs/api/liquid/objects/article) as a parameter.\nTo learn more about using this form, and its contents, refer to the [`article` template](/themes/architecture/templates/article#the-comment-form).\n", "syntax": "{% form 'new_comment', article %}\n form_content\n{% endform %}\n", "path": "/blogs/potion-notions/how-to-tell-if-you-have-run-out-of-invisibility-potion", "raw_liquid": "{% form 'new_comment', article %}\n <!-- form content -->\n{% endform %}", @@ -140,7 +140,7 @@ }, { "name": "product", - "description": "Generates a form for adding a product variant to the cart. The `product` form requires a [`product` object](/api/liquid/objects/product) as a parameter.\nTo learn more about using this form, and its contents, refer to the [`product` template](/themes/architecture/templates/product#the-product-form).\n", + "description": "Generates a form for adding a product variant to the cart. The `product` form requires a [`product` object](/docs/api/liquid/objects/product) as a parameter.\nTo learn more about using this form, and its contents, refer to the [`product` template](/themes/architecture/templates/product#the-product-form).\n", "syntax": "{% form 'product', product %}\n form_content\n{% endform %}\n", "path": "/products/health-potion", "raw_liquid": "{% form 'product', product %}\n <!-- form content -->\n{% endform %}", @@ -180,7 +180,7 @@ }, { "name": "return_to", - "description": "By default, each form type redirects customers to a specific page after the form submits. For example, the `product` form redirects to the cart page.\n\nThe `return_to` parameter allows you to specify a URL to redirect to. This can be done with the following values:\n\n| Value | Description |\n| --- | --- |\n| `back` | Redirect back to the same page that the customer was on before submitting the form. |\n| A relative path | A specific URL path. For example `/collections/all`. |\n| A [`routes` attribute](/api/liquid/objects/routes) | For example, `routes.root_url` |\n", + "description": "By default, each form type redirects customers to a specific page after the form submits. For example, the `product` form redirects to the cart page.\n\nThe `return_to` parameter allows you to specify a URL to redirect to. This can be done with the following values:\n\n| Value | Description |\n| --- | --- |\n| `back` | Redirect back to the same page that the customer was on before submitting the form. |\n| A relative path | A specific URL path. For example `/collections/all`. |\n| A [`routes` attribute](/docs/api/liquid/objects/routes) | For example, `routes.root_url` |\n", "syntax": "{% form 'form_type', return_to: string %}\n content\n{% endform %}\n", "path": "/", "raw_liquid": "{% form 'customer_login', return_to: routes.root_url %}\n <!-- form content -->\n{% endform %}", @@ -234,7 +234,7 @@ "category": "variable", "deprecated": false, "deprecation_reason": "", - "description": "You can create variables of any [basic type](/api/liquid/basics#types), [object](/api/liquid/objects), or object property.", + "description": "You can create variables of any [basic type](/docs/api/liquid/basics#types), [object](/docs/api/liquid/objects), or object property.", "parameters": [ ], @@ -272,7 +272,7 @@ "parameters": [ ], - "summary": "Stops a [`for` loop](/api/liquid/tags/for) from iterating.", + "summary": "Stops a [`for` loop](/docs/api/liquid/tags/for) from iterating.", "name": "break", "syntax": "{% break %}", "syntax_keywords": [ @@ -415,7 +415,7 @@ }, { "name": "Inline comments inside `liquid` tags", - "description": "You can use inline comment tags inside [`liquid` tags](/api/liquid/tags/liquid). The tag must be used for each line that you want to comment.\n", + "description": "You can use inline comment tags inside [`liquid` tags](/docs/api/liquid/tags/liquid). The tag must be used for each line that you want to comment.\n", "syntax": "", "path": "/", "raw_liquid": "{% liquid\n # this is a comment\n assign topic = 'Learning about comments!'\n echo topic\n%}", @@ -433,7 +433,7 @@ "parameters": [ ], - "summary": "Causes a [`for` loop](/api/liquid/tags/for) to skip to the next iteration.", + "summary": "Causes a [`for` loop](/docs/api/liquid/tags/for) to skip to the next iteration.", "name": "continue", "syntax": "{% continue %}", "syntax_keywords": [ @@ -460,7 +460,7 @@ "parameters": [ ], - "summary": "Loops through a group of strings and outputs them one at a time for each iteration of a [`for` loop](/api/liquid/tags/for).", + "summary": "Loops through a group of strings and outputs them one at a time for each iteration of a [`for` loop](/docs/api/liquid/tags/for).", "name": "cycle", "syntax": "{% cycle string, string, ... %}", "syntax_keywords": [ @@ -493,7 +493,7 @@ "category": "variable", "deprecated": false, "deprecation_reason": "", - "description": "Variables that are declared with `decrement` are unique to the [layout](/themes/architecture/layouts), [template](/themes/architecture/templates),\nor [section](/themes/architecture/sections) file that they're created in. However, the variable is shared across\n[snippets](/themes/architecture#snippets) included in the file.\n\nSimilarly, variables that are created with `decrement` are independent from those created with [`assign`](/api/liquid/tags/assign)\nand [`capture`](/api/liquid/tags/capture). However, `decrement` and [`increment`](/api/liquid/tags/increment) share\nvariables.", + "description": "Variables that are declared with `decrement` are unique to the [layout](/themes/architecture/layouts), [template](/themes/architecture/templates),\nor [section](/themes/architecture/sections) file that they're created in. However, the variable is shared across\n[snippets](/themes/architecture#snippets) included in the file.\n\nSimilarly, variables that are created with `decrement` are independent from those created with [`assign`](/docs/api/liquid/tags/assign)\nand [`capture`](/docs/api/liquid/tags/capture). However, `decrement` and [`increment`](/docs/api/liquid/tags/increment) share\nvariables.", "parameters": [ ], @@ -523,7 +523,7 @@ "category": "syntax", "deprecated": false, "deprecation_reason": "", - "description": "Using the `echo` tag is the same as wrapping an expression in curly brackets (`{{` and `}}`). However, unlike the curly\nbracket method, you can use the `echo` tag inside [`liquid` tags](/api/liquid/tags/liquid).\n\n> Tip:\n> You can use [filters](/api/liquid/filters) on expressions inside `echo` tags.", + "description": "Using the `echo` tag is the same as wrapping an expression in curly brackets (`{{` and `}}`). However, unlike the curly\nbracket method, you can use the `echo` tag inside [`liquid` tags](/docs/api/liquid/tags/liquid).\n\n> Tip:\n> You can use [filters](/docs/api/liquid/filters) on expressions inside `echo` tags.", "parameters": [ ], @@ -553,7 +553,7 @@ "category": "iteration", "deprecated": false, "deprecation_reason": "", - "description": "You can do a maximum of 50 iterations with a `for` loop. If you need to iterate over more than 50 items, then use the\n[`paginate` tag](/api/liquid/tags/paginate) to split the items over multiple pages.\n\n> Tip:\n> Every `for` loop has an associated [`forloop` object](/api/liquid/objects/forloop) with information about the loop.", + "description": "You can do a maximum of 50 iterations with a `for` loop. If you need to iterate over more than 50 items, then use the\n[`paginate` tag](/docs/api/liquid/tags/paginate) to split the items over multiple pages.\n\n> Tip:\n> Every `for` loop has an associated [`forloop` object](/docs/api/liquid/objects/forloop) with information about the loop.", "parameters": [ { "description": "The number of iterations to perform.", @@ -705,8 +705,8 @@ { "category": "theme", "deprecated": true, - "deprecation_reason": "Deprecated because the way that variables are handled reduces performance and makes code harder to both read and maintain.\n\nThe `include` tag has been replaced by [`render`](/api/liquid/tags/render).", - "description": "Inside the snippet, you can access and alter variables that are [created](/api/liquid/tags/variable-tags) outside of the\nsnippet.", + "deprecation_reason": "Deprecated because the way that variables are handled reduces performance and makes code harder to both read and maintain.\n\nThe `include` tag has been replaced by [`render`](/docs/api/liquid/tags/render).", + "description": "Inside the snippet, you can access and alter variables that are [created](/docs/api/liquid/tags/variable-tags) outside of the\nsnippet.", "parameters": [ ], @@ -727,7 +727,7 @@ "category": "variable", "deprecated": false, "deprecation_reason": "", - "description": "Variables that are declared with `increment` are unique to the [layout](/themes/architecture/layouts), [template](/themes/architecture/templates),\nor [section](/themes/architecture/sections) file that they're created in. However, the variable is shared across\n[snippets](/themes/architecture#snippets) included in the file.\n\nSimilarly, variables that are created with `increment` are independent from those created with [`assign`](/api/liquid/tags/assign)\nand [`capture`](/api/liquid/tags/capture). However, `increment` and [`decrement`](/api/liquid/tags/decrement) share\nvariables.", + "description": "Variables that are declared with `increment` are unique to the [layout](/themes/architecture/layouts), [template](/themes/architecture/templates),\nor [section](/themes/architecture/sections) file that they're created in. However, the variable is shared across\n[snippets](/themes/architecture#snippets) included in the file.\n\nSimilarly, variables that are created with `increment` are independent from those created with [`assign`](/docs/api/liquid/tags/assign)\nand [`capture`](/docs/api/liquid/tags/capture). However, `increment` and [`decrement`](/docs/api/liquid/tags/decrement) share\nvariables.", "parameters": [ ], @@ -787,7 +787,7 @@ "category": "theme", "deprecated": false, "deprecation_reason": "", - "description": "Inside snippets and app blocks, you can't directly access variables that are [created](/api/liquid/tags/variable-tags) outside\nof the snippet or app block. However, you can [specify variables as parameters](/api/liquid/tags/render#render-passing-variables-to-a-snippet)\nto pass outside variables to snippets.\n\nWhile you can't directly access created variables, you can access global objects, as well as any objects that are\ndirectly accessible outside the snippet or app block. For example, a snippet or app block inside the [product template](/themes/architecture/templates/product)\ncan access the [`product` object](/api/liquid/objects/product), and a snippet or app block inside a [section](/themes/architecture/sections)\ncan access the [`section` object](/api/liquid/objects/section).\n\nOutside a snippet or app block, you can't access variables created inside the snippet or app block.\n\n> Note:\n> When you render a snippet using the `render` tag, you can't use the [`include` tag](/api/liquid/tags/include)\n> inside the snippet.", + "description": "Inside snippets and app blocks, you can't directly access variables that are [created](/docs/api/liquid/tags/variable-tags) outside\nof the snippet or app block. However, you can [specify variables as parameters](/docs/api/liquid/tags/render#render-passing-variables-to-a-snippet)\nto pass outside variables to snippets.\n\nWhile you can't directly access created variables, you can access global objects, as well as any objects that are\ndirectly accessible outside the snippet or app block. For example, a snippet or app block inside the [product template](/themes/architecture/templates/product)\ncan access the [`product` object](/docs/api/liquid/objects/product), and a snippet or app block inside a [section](/themes/architecture/sections)\ncan access the [`section` object](/docs/api/liquid/objects/section).\n\nOutside a snippet or app block, you can't access variables created inside the snippet or app block.\n\n> Note:\n> When you render a snippet using the `render` tag, you can't use the [`include` tag](/docs/api/liquid/tags/include)\n> inside the snippet.", "parameters": [ ], @@ -803,7 +803,7 @@ "examples": [ { "name": "for", - "description": "You can render a snippet for every item in an array using the `for` parameter. You can also supply an optional `as` parameter to be able to reference the current item in the iteration inside the snippet.\nAdditionally, you can access a [`forloop` object](/api/liquid/objects/forloop) for the loop inside the snippet.\n", + "description": "You can render a snippet for every item in an array using the `for` parameter. You can also supply an optional `as` parameter to be able to reference the current item in the iteration inside the snippet.\nAdditionally, you can access a [`forloop` object](/docs/api/liquid/objects/forloop) for the loop inside the snippet.\n", "syntax": "{% render 'filename' for array as item %}", "path": "/", "raw_liquid": "", @@ -813,7 +813,7 @@ }, { "name": "Passing variables to a snippet", - "description": "Variables that have been [created](/api/liquid/tags/variable-tags) outside of a snippet can be passed to a snippet as parameters on the `render` tag.\n\n> Note:\n> Any changes that are made to a passed variable apply only within the snippet.\n", + "description": "Variables that have been [created](/docs/api/liquid/tags/variable-tags) outside of a snippet can be passed to a snippet as parameters on the `render` tag.\n\n> Note:\n> Any changes that are made to a passed variable apply only within the snippet.\n", "syntax": "{% render 'filename', variable: value %}", "path": "/", "raw_liquid": "", @@ -837,7 +837,7 @@ "category": "iteration", "deprecated": false, "deprecation_reason": "", - "description": "The `tablerow` tag must be wrapped in HTML `<table>` and `</table>` tags.\n\n> Tip:\n> Every `tablerow` loop has an associated [`tablerowloop` object](/api/liquid/objects/tablerowloop) with information about the loop.", + "description": "The `tablerow` tag must be wrapped in HTML `<table>` and `</table>` tags.\n\n> Tip:\n> Every `tablerow` loop has an associated [`tablerowloop` object](/docs/api/liquid/objects/tablerowloop) with information about the loop.", "parameters": [ { "description": "The number of columns that the table should have.", @@ -946,7 +946,7 @@ "category": "conditional", "deprecated": false, "deprecation_reason": "", - "description": "> Tip:\n> Similar to the [`if` tag](/api/liquid/tags/if), you can use `elsif` to add more conditions to an `unless` tag.", + "description": "> Tip:\n> Similar to the [`if` tag](/docs/api/liquid/tags/if), you can use `elsif` to add more conditions to an `unless` tag.", "parameters": [ ], @@ -980,7 +980,7 @@ "category": "iteration", "deprecated": false, "deprecation_reason": "", - "description": "Because [`for` loops](/api/liquid/tags/for) are limited to 50 iterations per page, you need to use the `paginate` tag to\niterate over an array that has more than 50 items. The following arrays can be paginated:\n\n- [`all_products`](/api/liquid/objects/all_products)\n- [`article.comments`](/api/liquid/objects/article#article-comments)\n- [`blog.articles`](/api/liquid/objects/blog#blog-articles)\n- [`collections`](/api/liquid/objects/collections)\n- [`collection.products`](/api/liquid/objects/collection#collection-products)\n- [`customer.addresses`](/api/liquid/objects/customer#customer-addresses)\n- [`customer.orders`](/api/liquid/objects/customer#customer-orders)\n- [`pages`](/api/liquid/objects/pages)\n- [`search.results`](/api/liquid/objects/search#search-results)\n- [`collection_list` settings](/themes/architecture/settings/input-settings#collection_list)\n- [`product_list` settings](/themes/architecture/settings/input-settings#product_list)\n\nWithin the `paginate` tag, you have access to the [`paginate` object](/api/liquid/objects/paginate). You can use this\nobject, or the [`default_pagination` filter](/api/liquid/filters/default_pagination), to build page navigation.", + "description": "Because [`for` loops](/docs/api/liquid/tags/for) are limited to 50 iterations per page, you need to use the `paginate` tag to\niterate over an array that has more than 50 items. The following arrays can be paginated:\n\n- [`all_products`](/docs/api/liquid/objects/all_products)\n- [`article.comments`](/docs/api/liquid/objects/article#article-comments)\n- [`blog.articles`](/docs/api/liquid/objects/blog#blog-articles)\n- [`collections`](/docs/api/liquid/objects/collections)\n- [`collection.products`](/docs/api/liquid/objects/collection#collection-products)\n- [`customer.addresses`](/docs/api/liquid/objects/customer#customer-addresses)\n- [`customer.orders`](/docs/api/liquid/objects/customer#customer-orders)\n- [`pages`](/docs/api/liquid/objects/pages)\n- [`search.results`](/docs/api/liquid/objects/search#search-results)\n- [`collection_list` settings](/themes/architecture/settings/input-settings#collection_list)\n- [`product_list` settings](/themes/architecture/settings/input-settings#product_list)\n\nWithin the `paginate` tag, you have access to the [`paginate` object](/docs/api/liquid/objects/paginate). You can use this\nobject, or the [`default_pagination` filter](/docs/api/liquid/filters/default_pagination), to build page navigation.", "parameters": [ { "description": "The number of pages to display in the pagination.", @@ -1025,7 +1025,7 @@ }, { "name": "Paginating setting arrays", - "description": "To allow the pagination of `product_list` and `collection_list` settings to operate independently from other paginated lists on a page, these lists use a pagination query parameter with a unique key. The key is automatically assigned by the `paginate` tag, and you don't need to reference the key in your code. However, you can access the key using [`paginate.page_param`](/api/liquid/objects/paginate#paginate-page_param).\n\n> Tip:\n> To paginate two arrays independently without refreshing the entire page, you can use the [Section Rendering API](/api/section-rendering).\n", + "description": "To allow the pagination of `product_list` and `collection_list` settings to operate independently from other paginated lists on a page, these lists use a pagination query parameter with a unique key. The key is automatically assigned by the `paginate` tag, and you don't need to reference the key in your code. However, you can access the key using [`paginate.page_param`](/docs/api/liquid/objects/paginate#paginate-page_param).\n\n> Tip:\n> To paginate two arrays independently without refreshing the entire page, you can use the [Section Rendering API](/api/section-rendering).\n", "syntax": "", "path": "/", "raw_liquid": "", @@ -1172,7 +1172,7 @@ "category": "conditional", "deprecated": false, "deprecation_reason": "", - "description": "You can use the `else` tag with the following tags:\n\n- [`case`](/api/liquid/tags/case)\n- [`if`](/api/liquid/tags/if)\n- [`unless`](/api/liquid/tags/unless)", + "description": "You can use the `else` tag with the following tags:\n\n- [`case`](/docs/api/liquid/tags/case)\n- [`if`](/docs/api/liquid/tags/if)\n- [`unless`](/docs/api/liquid/tags/unless)", "parameters": [ ], @@ -1206,7 +1206,7 @@ "parameters": [ ], - "summary": "Allows you to specify a default expression to execute when a [`for` loop](/api/liquid/tags/for) has zero length.", + "summary": "Allows you to specify a default expression to execute when a [`for` loop](/docs/api/liquid/tags/for) has zero length.", "name": "else", "syntax": "{% for variable in array %}\n first_expression\n{% else %}\n second_expression\n{% endfor %}", "syntax_keywords": [ @@ -1244,7 +1244,7 @@ "category": "syntax", "deprecated": false, "deprecation_reason": "", - "description": "Because the tags don't have delimeters, each tag needs to be on its own line.\n\n> Tip:\n> Use the [`echo` tag](/api/liquid/tags/echo) to output an expression inside `liquid` tags.", + "description": "Because the tags don't have delimeters, each tag needs to be on its own line.\n\n> Tip:\n> Use the [`echo` tag](/docs/api/liquid/tags/echo) to output an expression inside `liquid` tags.", "parameters": [ ], @@ -1270,4 +1270,4 @@ } ] } -] \ No newline at end of file +]