diff --git a/data/filters.json b/data/filters.json index cdd96da..49e023a 100644 --- a/data/filters.json +++ b/data/filters.json @@ -4,9 +4,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -36,9 +34,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Accepts the following object types:\n\n- `product`\n- `variant`", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -78,9 +74,7 @@ "deprecated": false, "deprecation_reason": "", "description": "<aside class=\"note beta\">\n <h4>Developer preview</h4>\n <p>Style settings are currently only available as part of the <a href=\"/storefronts/themes/architecture/blocks/theme-blocks/developer-preview\">Theme blocks developer preview</a>.</p>\n</aside>", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -116,9 +110,7 @@ "name": "HTML", "positional": true, "required": false, - "types": [ - - ] + "types": [] } ], "return_type": [ @@ -166,9 +158,7 @@ "name": "HTML", "positional": true, "required": false, - "types": [ - - ] + "types": [] } ], "return_type": [ @@ -210,9 +200,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Accepts the following values:\n\n- `manual` (as defined in the [collection settings](https://help.shopify.com/manual/products/collections/collection-layout#change-the-sort-order-for-the-products-in-a-collection))\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": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -242,9 +230,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -274,9 +260,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -306,9 +290,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -378,9 +360,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -808,9 +788,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Because colors are converted to `hex6` format, if a color with an alpha component is provided, then the alpha component\nis excluded from the output.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -840,9 +818,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If a color with an alpha component is provided, the color is converted to `HSLA` format.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -872,9 +848,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If a color with an alpha component is provided, then the color is converted to `RGBA` format.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -954,9 +928,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The secret key for the message is supplied as a parameter to the filter.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -986,9 +958,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The secret key for the message is supplied as a parameter to the filter.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1018,9 +988,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1050,9 +1018,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1082,9 +1048,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1183,9 +1147,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1215,9 +1177,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1247,9 +1207,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1355,9 +1313,7 @@ "name": "font_display", "positional": false, "required": false, - "types": [ - - ] + "types": [] } ], "return_type": [ @@ -1508,9 +1464,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1519,9 +1473,7 @@ "array_value": "" } ], - "examples": [ - - ], + "examples": [], "summary": "Generates default error messages for each possible value of [`form.errors`](/docs/themes/liquid/reference/objects/form#form-errors).", "syntax": "string | default_errors", "name": "default_errors" @@ -1531,9 +1483,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> You can't render accelerated checkout buttons through AJAX requests, including those through the\n> [Section Rendering API](/api/section-rendering). The accelerated 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.\n>\n> For guidance on styling or event tracking of accelerated checkout buttons, see [accelerated checkout](/docs/storefronts/themes/pricing-payments/accelerated-checkout/).\n```liquid\n{% form 'product', product %}\n {{ form | payment_button }}\n{% endform %}\n```", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1542,9 +1492,7 @@ "array_value": "" } ], - "examples": [ - - ], + "examples": [], "summary": "Generates an HTML container to host [accelerated 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" @@ -1554,9 +1502,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1565,9 +1511,7 @@ "array_value": "" } ], - "examples": [ - - ], + "examples": [], "summary": "Generates the HTML for the [Shop Pay Installments banner](/themes/pricing-payments/installments).", "syntax": "form | payment_terms", "name": "payment_terms" @@ -1656,9 +1600,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The `translate` filter has an alias of `t`, which is more commonly used.\n\n> Tip:\n> To learn more about using the `t` filter, refer to [storefront locale file usage](/themes/architecture/locales/storefront-locale-files#usage)\n> or [schema locale file usage](/themes/architecture/locales/schema-locale-files#usage).", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1698,9 +1640,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The asset size must be less than 15KB to be inlined.\n>", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1730,9 +1670,7 @@ "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](/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": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1762,9 +1700,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -1794,9 +1730,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1826,9 +1760,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -1858,9 +1790,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -1890,9 +1820,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1922,9 +1850,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1954,9 +1880,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -1986,9 +1910,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2018,9 +1940,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2050,9 +1970,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -2082,9 +2000,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -2114,9 +2030,7 @@ "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](/docs/api/liquid/filters/uniq).", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -2196,9 +2110,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -2228,9 +2140,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2260,9 +2170,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2292,9 +2200,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2324,9 +2230,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "untyped", @@ -2366,9 +2270,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -2398,9 +2300,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2440,9 +2340,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "untyped", @@ -2482,9 +2380,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2514,9 +2410,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -2546,9 +2440,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -2578,9 +2470,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -2610,9 +2500,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2642,9 +2530,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -2674,9 +2560,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2706,9 +2590,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2738,9 +2620,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2770,9 +2650,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2802,9 +2680,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2834,9 +2710,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2866,9 +2740,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -2898,9 +2770,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -2940,9 +2810,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -2982,9 +2850,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3014,9 +2880,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The size of a string is the number of characters that the string includes. The size of an array is the number of items\nin the array.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -3056,9 +2920,7 @@ "deprecated": false, "deprecation_reason": "", "description": "By default, the substring has a length of one character, and the array series has one array item. However, you can\nprovide a second parameter to specify the number of characters or array items.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3098,9 +2960,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -3140,9 +3000,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Caution:\n> You shouldn't use the `sort_natural` filter to sort numerical values. When comparing items an array, each item is converted to a\n> string, so sorting on numerical values can lead to unexpected results.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -3182,9 +3040,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -3214,9 +3070,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3246,9 +3100,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3278,9 +3130,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3310,9 +3160,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -3352,9 +3200,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "number", @@ -3384,9 +3230,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the specified number of characters is less than the length of the string, then an ellipsis (`...`) is appended to\nthe truncated string. The ellipsis is included in the character count of the truncated string.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3426,9 +3270,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the specified number of words is less than the number of words in the string, then an ellipsis (`...`) is appended to\nthe truncated string.\n\n> Caution:\n> HTML tags are treated as words, so you should strip any HTML from truncated content. If you don't strip HTML, then\n> closing HTML tags can be removed, which can result in unexpected behavior.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3468,9 +3310,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -3500,9 +3340,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3532,9 +3370,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3564,9 +3400,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Spaces are converted to a `+` character, instead of a percent-encoded character.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3596,9 +3430,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This requires you to provide both the property name and the associated value.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "array", @@ -3638,9 +3470,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If [alt text is set on the video](https://help.shopify.com/en/manual/products/product-media/add-alt-text), then it's\nincluded in the `title` attribute of the `<iframe>`. If no alt text is set, then the `title` attribute is set to the\nproduct title.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -3680,9 +3510,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4275,9 +4103,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4307,9 +4133,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4339,9 +4163,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4371,9 +4193,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4403,9 +4223,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4435,9 +4253,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use with the [`customer.has_avatar?`](/docs/api/liquid/objects/customer#customer-has_avatar?) method to determine if the customer has an avatar.\n\n```liquid\n{{ customer | avatar }}\n```", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4446,9 +4262,7 @@ "array_value": "" } ], - "examples": [ - - ], + "examples": [], "summary": "Generates HTML to render a customer's avatar, if available.", "syntax": "customer | avatar", "name": "avatar" @@ -4508,9 +4322,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4540,9 +4352,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The `handleize` filter has an alias of `handle`.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4572,9 +4382,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4604,9 +4412,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The `url_param_escape` filter escapes the same characters as [`url_escape`](/docs/api/liquid/filters/url_escape), with the\naddition of `&`.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4636,9 +4442,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The `structured_data` filter can be used on the [`product`](/docs/api/liquid/objects/product) and [`article`](/docs/api/liquid/objects/article) objects.\n\nProduct objects are output as a [schema.org `Product`](https://schema.org/Product) if they have no variants, and a [`ProductGroup`](https://schema.org/ProductGroup) if they have one or more variants.\n\nArticle objects are output as a [schema.org `Article`.](https://schema.org/Article)", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4668,9 +4472,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4700,9 +4502,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn more about filtering by tag, refer to [Filter articles by tag](/themes/architecture/templates/blog#filter-articles-by-tag)\n> or [Filter collections by tag](/themes/navigation-search/filtering/tag-filtering).", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4732,9 +4532,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn more about filtering by tag, refer to [Filter articles by tag](/themes/architecture/templates/blog#filter-articles-by-tag)\n> or [Filter collections by tag](/themes/navigation-search/filtering/tag-filtering).", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4764,9 +4562,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn more about filtering by tag, refer to [Filter articles by tag](/themes/architecture/templates/blog#filter-articles-by-tag)\n> or [Filter collections by tag](/themes/navigation-search/filtering/tag-filtering).", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4796,9 +4592,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -4878,9 +4672,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Caution:\n> The `pluralize` filter applies English pluralization rules to determine which string to output. You shouldn't use this\n> filter on non-English strings because it could lead to incorrect pluralizations.", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -5010,9 +4802,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -5182,9 +4972,7 @@ "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`](/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": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -5565,9 +5353,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -5797,9 +5583,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", @@ -5829,9 +5613,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The following are the globally accessible Shopify assets:\n\n- `option_selection.js`\n- `api.jquery.js`\n- `shopify_common.js`\n- `customer_area.js`\n- `currencies.js`\n- `customer.css`", - "parameters": [ - - ], + "parameters": [], "return_type": [ { "type": "string", diff --git a/data/objects.json b/data/objects.json index d1f90d0..60d6710 100644 --- a/data/objects.json +++ b/data/objects.json @@ -16,9 +16,7 @@ "property": "featured_media" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -28,9 +26,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -46,9 +42,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the source is a [`file_reference` metafield](/apps/metafields/types), then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -109,9 +103,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Preview images don't have an ID attribute.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -127,9 +119,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -144,17 +134,13 @@ ], "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": [ - - ], + "examples": [], "json_data": { "path": "/products/dandelion-milk", "handle": "product.media[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -193,9 +179,7 @@ "property": "address" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -205,9 +189,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no company is specified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -223,9 +205,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no phone number is specified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -241,9 +221,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -259,9 +237,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -277,9 +253,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -295,9 +269,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This only applies to customer addresses.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -313,9 +285,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -331,9 +301,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -349,9 +317,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -367,9 +333,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no second line is specified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -385,9 +349,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -403,9 +365,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -421,9 +381,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -439,9 +397,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The value doesn't include the preceding [ISO 3166-1](https://www.iso.org/glossary-for-iso-3166.html) country code.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -457,9 +413,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "country", @@ -475,9 +429,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -493,9 +445,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -510,34 +460,24 @@ ], "summary": "An address, such as a customer address or order shipping address.", "name": "address", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "shop.address", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "summary": "All of the [collections](/docs/api/liquid/objects/collection) on a store.", "name": "collections", "examples": [ @@ -579,19 +519,13 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "summary": "All of the [pages](/docs/api/liquid/objects/page) on a store.", "name": "pages", "examples": [ @@ -633,19 +567,13 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The `all_products` object has a limit of 20 unique handles per page. If you want more than 20 products,\nthen consider using a collection instead.", - "properties": [ - - ], + "properties": [], "summary": "All of the products on a store.", "name": "all_products", "examples": [ @@ -677,12 +605,8 @@ { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -692,29 +616,21 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], - "return_type": [ - - ], + "examples": [], + "return_type": [], "summary": "The [metafields](/docs/api/liquid/objects/metafield) that are [owned by the app](/apps/metafields/app-owned).", "name": "metafields" } ], "summary": "An app. This object is usually used to access app-specific information for use with [theme app extensions](/apps/online-store/theme-app-extensions).", "name": "app", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -737,9 +653,7 @@ "property": "discount" } ], - "template": [ - - ] + "template": [] }, "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`](/docs/api/liquid/objects/discount_allocation) and\n[`discount_application`](/docs/api/liquid/objects/discount_application) objects.", @@ -749,9 +663,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -767,9 +679,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -785,9 +695,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This is the same value as [`discount.title`](/docs/api/liquid/objects/discount#discount-title).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -803,9 +711,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This is the same value as [`discount.code`](/docs/api/liquid/objects/discount#discount-code).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -821,9 +727,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -851,9 +755,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -869,9 +771,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -886,34 +786,24 @@ ], "summary": "A discount applied to a cart, line item, or order.", "name": "discount", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[2].discounts[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "summary": "All of the articles across the blogs in the store.", "name": "articles", "examples": [ @@ -967,9 +857,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -985,9 +873,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1003,9 +889,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -1021,9 +905,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1039,9 +921,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1057,9 +937,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1075,9 +953,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1093,9 +969,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The name doesn't include the `article.` prefix, or the file extension (`.json` or `.liquid`).\n\n If a custom template isn't assigned to the article, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1111,9 +985,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1129,9 +1001,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1147,9 +1017,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1165,9 +1033,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -1183,9 +1049,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -1201,9 +1065,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -1219,9 +1081,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -1237,9 +1097,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1255,9 +1113,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1273,9 +1129,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1291,9 +1145,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1336,9 +1188,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "user", @@ -1353,17 +1203,13 @@ ], "summary": "An article, or [blog post](https://help.shopify.com/manual/online-store/blogs/writing-blogs), in a blog.", "name": "article", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/blogs/potion-notions/how-to-tell-if-you-have-run-out-of-invisibility-potion", "handle": "article", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -1374,9 +1220,7 @@ "property": "blocks" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -1386,9 +1230,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1404,9 +1246,7 @@ "deprecated": false, "deprecation_reason": "", "description": "To learn about how to access settings, refer to [Access settings](/themes/architecture/settings#access-settings). To learn which input settings can be applied to the `type` property within settings, refer to [Input settings](/themes/architecture/settings/input-settings).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -1422,9 +1262,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The type is a free-form string that's defined in the [block's schema](/themes/architecture/sections/section-schema#blocks).\nYou can use the type as an identifier. For example, you might display different markup based on the block type.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1440,9 +1278,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The theme editor's [JavaScript API](/themes/architecture/sections/integrate-sections-with-the-theme-editor#section-and-block-javascript-events)\nuses the data attributes to identify blocks and listen for events. No value for `block.shopify_attributes` is returned\noutside the theme editor.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1457,34 +1293,24 @@ ], "summary": "The content and settings of a [section block](/themes/architecture/sections/section-schema#blocks).", "name": "block", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"id\":\"column1\",\"settings\":\"array\",\"shopify_attributes\":\"data-shopify-editor-block=\\\"{\\\"id\\\":\\\"column1\\\",\\\"type\\\":\\\"column\\\"}\\\"\",\"type\":\"column\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "summary": "All of the blogs in the store.", "name": "blogs", "examples": [ @@ -1516,9 +1342,7 @@ { "access": { "global": false, - "parents": [ - - ], + "parents": [], "template": [ "blog", "article" @@ -1532,9 +1356,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -1550,9 +1372,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1568,9 +1388,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1586,9 +1404,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -1604,9 +1420,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -1622,9 +1436,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -1640,9 +1452,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1658,9 +1468,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The name doesn't include the `blog.` prefix, or the file extension (`.json` or `.liquid`).\n\n If a custom template isn't assigned to the blog, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1676,9 +1484,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This includes tags of articles that aren't in the current pagination view.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -1694,9 +1500,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -1712,9 +1516,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -1730,9 +1532,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -1748,9 +1548,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Returns `nil` if there is no next article.\n\nThis property can be used on the [article page](/themes/architecture/templates/article) to output `next` links.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "article", @@ -1766,9 +1564,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Returns `nil` if there is no previous article.\n\nThis property can be used on the [article page](/themes/architecture/templates/article) to output `previous` links.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "article", @@ -1783,17 +1579,13 @@ ], "summary": "Information about a specific [blog](https://help.shopify.com/manual/online-store/blogs/adding-a-blog) in the store.", "name": "blog", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/blogs/potion-notions/new-potions-for-spring", "handle": "blog", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -1804,9 +1596,7 @@ "property": "brand" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -1816,9 +1606,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1834,9 +1622,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -1852,9 +1638,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -1870,9 +1654,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -1888,9 +1670,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -1906,9 +1686,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -1924,12 +1702,8 @@ "deprecated": false, "deprecation_reason": "", "description": "To learn about how to access brand colors, refer to [`brand_color`](/docs/api/liquid/objects/brand_color).", - "examples": [ - - ], - "return_type": [ - - ], + "examples": [], + "return_type": [], "summary": "The brand's colors.", "name": "colors" }, @@ -1949,33 +1723,25 @@ "show_data_tab": true } ], - "return_type": [ - - ], + "return_type": [], "summary": "The social links for the brand.", "name": "metafields" } ], "summary": "The [brand assets](https://help.shopify.com/manual/promoting-marketing/managing-brand-assets) for the store.", "name": "brand", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "shop.brand", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], + "parents": [], "template": [ "cart" ] @@ -1988,9 +1754,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -2033,9 +1797,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2051,9 +1813,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2069,9 +1829,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2087,9 +1845,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2105,9 +1861,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2123,9 +1877,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2141,9 +1893,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -2159,9 +1909,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -2177,12 +1925,8 @@ "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`](/docs/api/liquid/objects/shop#shop-enabled_currencies).", - "examples": [ - - ], - "return_type": [ - - ], + "examples": [], + "return_type": [], "summary": "The currency of the cart.", "name": "currency" }, @@ -2190,9 +1934,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`weight_with_unit`](/docs/api/liquid/filters/weight_with_unit) filter to format the weight in\n> [the store's format](https://www.shopify.com/admin/settings/general), or override the default unit.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2289,9 +2031,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`](/docs/api/liquid/objects/cart#cart-discount_applications).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -2307,9 +2047,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This can be set in a store’s [tax settings](https://www.shopify.com/admin/settings/taxes).\n\nIf the store includes or exclude tax [based on the customer’s country](https://help.shopify.com/manual/taxes/location#include-or-exclude-tax-based-on-your-customers-country),\nthen the value reflects the tax requirements of the customer’s country.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -2325,9 +2063,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -2342,17 +2078,13 @@ ], "summary": "A customer’s cart.", "name": "cart", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "cart", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -2375,9 +2107,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -2393,9 +2123,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2411,9 +2139,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2429,9 +2155,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2447,9 +2171,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2465,9 +2187,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The name doesn't include the `collection.` prefix, or the file extension (`.json` or `.liquid`).\n\n If a custom template isn't assigned to the collection, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2483,9 +2203,7 @@ "deprecated": false, "deprecation_reason": "", "description": "You can query for products from a certain vendor at the `/collections/vendors` URL\nwith a query parameter in the format of `?q=[vendor]`, where `[vendor]` is your desired product vendor.\n\n> Tip:\n> The query value is case-insensitive, so `apparelco` is equivalent to `ApparelCo` or `APPARELCO`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2501,9 +2219,7 @@ "deprecated": false, "deprecation_reason": "", "description": "You can query for products of a certain type at the `/collections/types` URL\nwith a query parameter in the format of `?q=[type]`, where `[type]` is your desired product type.\n\n> Tip:\n> The query value is case-insensitive, so `shirts` is equivalent to `Shirts` or `SHIRTS`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2519,9 +2235,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2537,9 +2251,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2555,9 +2267,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This image is added on the collection's page in the Shopify admin.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -2600,9 +2310,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there's no `sort_by` URL parameter, then the value is `nil`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2618,9 +2326,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This is set on the collection's page in the Shopify admin.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -2672,9 +2378,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property can be used on the [product page](/themes/architecture/templates/product) to output `next` links.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "product", @@ -2690,9 +2394,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property can be used on the [product page](/themes/architecture/templates/product) to output `previous` links.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "product", @@ -2708,9 +2410,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2726,9 +2426,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -2744,9 +2442,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`](/docs/api/liquid/objects/collection#collection-products_count).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2762,9 +2458,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`](/docs/api/liquid/objects/collection#collection-tags).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -2780,9 +2474,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This doesn't include tags for products that have been filtered out of the current view.\nReturns `nil` if no tags have been applied, or all products with tags have been filtered out of the current view.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -2852,9 +2544,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Only filters relevant to the current collection are returned. Filters will be empty for collections that contain over 5000 products.\n\nTo learn about supporting filters in your theme, refer to [Support storefront filtering](/themes/navigation-search/filtering/storefront-filtering/support-storefront-filtering).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -2870,9 +2560,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -2887,17 +2575,13 @@ ], "summary": "A [collection](https://help.shopify.com/manual/products/collections) in a store.", "name": "collection", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/collections/ingredients/burning", "handle": "collection", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -2908,16 +2592,12 @@ "property": "colors" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "summary": "The colors defined as part of a store's [brand assets](https://help.shopify.com/manual/promoting-marketing/managing-brand-assets).", "name": "brand_color", "examples": [ @@ -2955,9 +2635,7 @@ "property": "color" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -2967,9 +2645,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -2985,9 +2661,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3003,9 +2677,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3021,9 +2693,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3039,9 +2709,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3057,9 +2725,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3075,9 +2741,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3093,9 +2757,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3111,9 +2773,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3145,19 +2805,13 @@ "handle": "settings.colors_accent_2", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -3167,9 +2821,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3185,9 +2837,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -3219,26 +2869,18 @@ "handle": "settings.card_color_scheme", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about color schemes in themes, refer to [`color_scheme` setting](/themes/architecture/settings/input-settings#color_scheme).", - "properties": [ - - ], + "properties": [], "summary": "A color_scheme_group from a [`color_scheme_group` setting](/themes/architecture/settings/input-settings#color_scheme_group).", "name": "color_scheme_group", "examples": [ @@ -3258,9 +2900,7 @@ "handle": "settings.color_schemes", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -3271,9 +2911,7 @@ "property": "shipping_address" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -3283,9 +2921,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3301,9 +2937,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3319,9 +2953,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3337,9 +2969,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no second line is specified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3355,9 +2985,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3373,9 +3001,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3391,9 +3017,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3409,9 +3033,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3427,9 +3049,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3445,9 +3065,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The value doesn't include the preceding [ISO 3166-1](https://www.iso.org/glossary-for-iso-3166.html) country code.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3463,9 +3081,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "country", @@ -3481,9 +3097,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3499,9 +3113,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3516,17 +3128,13 @@ ], "summary": "The address of a company location.", "name": "company_address", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.company_available_locations[0].shipping_address", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -3541,9 +3149,7 @@ "property": "current_company" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -3553,9 +3159,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3571,9 +3175,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3589,9 +3191,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3607,9 +3207,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -3625,9 +3223,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3643,9 +3239,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -3660,17 +3254,13 @@ ], "summary": "A company that a [customer](/docs/api/liquid/objects/customer) is purchasing for.", "name": "company", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.company_available_locations[0].company", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -3689,9 +3279,7 @@ "property": "current_location" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -3701,9 +3289,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3719,9 +3305,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3737,9 +3321,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3755,9 +3337,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3773,9 +3353,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -3791,9 +3369,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "company", @@ -3809,9 +3385,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "company_address", @@ -3827,9 +3401,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -3845,9 +3417,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -3862,47 +3432,33 @@ ], "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": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.company_available_locations[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "Include the `content_for_header` object in your [layout files](/themes/architecture/layouts) between the `<head>` and\n`</head>` HTML tags.\n\nYou shouldn't try to modify or parse the `content_for_header` object because the contents are subject to change, which can\nchange the behaviour of your code.\n\n> Note:\n> The `content_for_header` object is required in `theme.liquid`.", - "properties": [ - - ], + "properties": [], "summary": "Dynamically returns all scripts required by Shopify.", "name": "content_for_header", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -3925,9 +3481,7 @@ "property": "country" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -3937,9 +3491,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3955,9 +3507,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3973,9 +3523,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -3997,9 +3545,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "currency", @@ -4015,9 +3561,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "market", @@ -4033,9 +3577,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -4051,9 +3593,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Possible values are `Africa`, `Asia`, `Central America`, `Europe`, `North America`, `Oceania`, and `South America`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4069,9 +3609,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -4113,9 +3651,7 @@ "handle": "localization.country", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -4146,9 +3682,7 @@ "property": "money_with_currency_format" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -4158,9 +3692,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4176,9 +3708,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4194,9 +3724,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4211,17 +3739,13 @@ ], "summary": "Information about a currency, like the ISO code and symbol.", "name": "currency", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "localization.country.currency", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -4254,9 +3778,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4272,9 +3794,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4290,9 +3810,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4308,9 +3826,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4326,9 +3842,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -4344,9 +3858,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "order", @@ -4362,9 +3874,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4380,9 +3890,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4398,9 +3906,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This phone number is only populated if the customer checks out using a phone number during checkout, opts in to SMS\nnotifications, or if the merchant has manually entered it.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4416,9 +3922,7 @@ "deprecated": false, "deprecation_reason": "", "description": "A customer can complete a checkout without making an account with the store. If the customer\ndoesn't have an account with the store, then `customer.has_account` is `false` at checkout.\n\nDuring the checkout process, if the customer has an account with the store and enters an email associated\nwith an account, then `customer.has_account` is `true`. The email is associated with the account regardless\nof whether the customer has logged into their account.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -4434,9 +3938,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -4452,9 +3954,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4470,9 +3970,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -4488,9 +3986,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "address", @@ -4506,9 +4002,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -4524,9 +4018,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4542,9 +4034,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -4560,9 +4050,7 @@ "deprecated": false, "deprecation_reason": "", "description": "To learn about B2B in themes, refer to [Support B2B customers in your theme](/themes/pricing-payments/b2b).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -4578,9 +4066,7 @@ "deprecated": false, "deprecation_reason": "", "description": "To learn about B2B in themes, refer to [Support B2B customers in your theme](/themes/pricing-payments/b2b).\n\n> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many company locations to show at once, up to a limit of 100.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -4596,9 +4082,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4614,9 +4098,7 @@ "deprecated": false, "deprecation_reason": "", "description": "To learn about B2B in themes, refer to [Support B2B customers in your theme](/themes/pricing-payments/b2b).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "company_location", @@ -4632,9 +4114,7 @@ "deprecated": false, "deprecation_reason": "", "description": "To learn about B2B in themes, refer to [Support B2B customers in your theme](/themes/pricing-payments/b2b).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "company", @@ -4650,9 +4130,7 @@ "deprecated": false, "deprecation_reason": "", "description": "A customer may have an avatar associated with their account, which can be displayed in the storefront.\n\n> Tip:\n> Use with the [`avatar`](/docs/api/liquid/filters/avatar) filter to render the customer's avatar.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -4684,9 +4162,7 @@ "handle": "customer", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -4701,9 +4177,7 @@ "property": "discount_allocations" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -4713,9 +4187,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "discount_application", @@ -4731,9 +4203,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4748,17 +4218,13 @@ ], "summary": "Information about how a discount affects an item.", "name": "discount_allocation", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[2].line_items[0].discount_allocations[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -4777,9 +4243,7 @@ "property": "discount_application" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -4789,9 +4253,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4807,9 +4269,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4825,9 +4285,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -4843,9 +4301,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](/docs/api/liquid/objects/discount_application#discount_application-target_type).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4873,9 +4329,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4909,9 +4363,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4933,9 +4385,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -4956,17 +4406,13 @@ ], "summary": "Information about the intent of a discount.", "name": "discount_application", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "cart.discount_applications[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -4977,9 +4423,7 @@ "property": "media" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -4989,9 +4433,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5007,9 +4449,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5025,9 +4465,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5049,9 +4487,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5067,9 +4503,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5112,9 +4546,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5130,9 +4562,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Preview images don't have an ID attribute.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -5147,17 +4577,13 @@ ], "summary": "Information about an external video from YouTube or Vimeo.", "name": "external_video", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/potion-beats", "handle": "product.featured_media", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -5172,9 +4598,7 @@ "property": "filters" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -5184,9 +4608,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5202,9 +4624,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5220,9 +4640,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Example:\nFor a filter named `color` with values `red` and `blue`:\n - If the operator is `AND`, it will filter items that are both red and blue.\n - If the operator is `OR`, it will filter items that are either red or blue or both.\n\nFilters that support the `AND` operator:\n - Product tags\n - Metafields of type `list.single_line_text_field` and `list.metaobject_reference`", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5244,9 +4662,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5274,9 +4690,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -5292,9 +4706,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The array can have values only for `boolean` and `list` type filters.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -5310,9 +4722,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -5328,9 +4738,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "filter_value", @@ -5346,9 +4754,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "filter_value", @@ -5364,9 +4770,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "filter_value", @@ -5382,9 +4786,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "filter_value", @@ -5400,9 +4802,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5418,9 +4818,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5436,9 +4834,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5465,17 +4861,13 @@ ], "summary": "A [storefront filter](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters).", "name": "filter", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/search?q=potion&filter.v.option.strength=Low", "handle": "search.filters.to_a[3]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -5486,9 +4878,7 @@ "property": "display" } ], - "template": [ - - ] + "template": [] }, "deprecated": true, "deprecation_reason": "Deprecated in favor of the [swatch](/docs/api/liquid/objects/swatch) drop.", @@ -5498,9 +4888,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5522,9 +4910,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Can be a list of [`colors`](/docs/api/liquid/objects/color) or an [`image`](/docs/api/liquid/objects/image).\nRefer to the [`type`](#filter_value_display-type) property to determine the type of visual representation.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -5539,17 +4925,13 @@ ], "summary": "The visual representation of a filter value.", "name": "filter_value_display", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -5576,9 +4958,7 @@ "property": "min_value" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -5588,9 +4968,7 @@ "deprecated": false, "deprecation_reason": "", "description": "For example, `filter.v.option.color`.\n\nFilters of type `price_range` include an extra component depending on whether the filter value is for the filter's\n`min_value` or `max_value`. The following table outlines the URL parameter for each:\n\n| Value type | URL parameter |\n| --- | --- |\n| `min_value` | `filter.v.price.gte` |\n| `max_value` | `filter.v.price.lte` |", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5606,9 +4984,7 @@ "deprecated": false, "deprecation_reason": "", "description": "For example, `High` will be used in the URL as `filter.v.option.strength=High`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5624,9 +5000,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -5642,9 +5016,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5660,9 +5032,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5678,9 +5048,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Any [pagination](/docs/api/liquid/tags/paginate) URL parameters are removed.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5696,9 +5064,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Any [pagination](/docs/api/liquid/tags/paginate) URL parameters are also removed.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5714,9 +5080,7 @@ "deprecated": true, "deprecation_reason": "Deprecated in favor of the [swatch](#swatch) attribute.", "description": "Returns a visual representation for the filter value.\nIf no visual representation is available, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "filter_value_display", @@ -5732,9 +5096,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Returns a [swatch](/docs/api/liquid/objects/swatch) drop for the filter value.\nRequires the [filter presentation](/docs/api/liquid/objects/filter#filter-presentation) to be `swatch` and saved color or image content for the swatch. Otherwise, returns `nil`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "swatch", @@ -5750,9 +5112,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Returns an [image](/docs/api/liquid/objects/image) drop for the filter value.\nRequires the [filter presentation](/docs/api/liquid/objects/filter#filter-presentation) to be `image` and for an image to be available. Otherwise, returns `nil`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -5767,17 +5127,13 @@ ], "summary": "A specific value of a filter.", "name": "filter_value", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/search?q=potion&filter.v.option.strength=Low", "handle": "search.filters.to_a[3].values[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -5788,9 +5144,7 @@ "property": "focal_point" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -5800,9 +5154,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5818,9 +5170,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5852,19 +5202,13 @@ "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -5874,9 +5218,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> If the family name contains non-alphanumeric characters (A-Z, a-z, 0-9, or '-'), then it will be wrapped in double quotes.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5892,9 +5234,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5910,9 +5250,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5928,9 +5266,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -5946,9 +5282,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -5964,9 +5298,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -5982,9 +5314,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -5999,27 +5329,19 @@ ], "summary": "A font from a [`font_picker` setting](/themes/architecture/settings/input-settings#font_picker).", "name": "font", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "settings.type_header_font", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -6029,9 +5351,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](/docs/api/liquid/filters/default_errors) to `form.errors` to output default\n> error messages without having to loop through the array.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "form_errors", @@ -6047,9 +5367,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6065,9 +5383,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6083,9 +5399,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`new_comment` form](/docs/api/liquid/tags/form#form-new_comment).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6101,9 +5415,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6119,9 +5431,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6137,9 +5447,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6155,9 +5463,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6173,9 +5479,7 @@ "deprecated": false, "deprecation_reason": "", "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)\n- [`product`](/docs/api/liquid/tags/form#form-product)", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6191,9 +5495,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6209,9 +5511,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6227,9 +5527,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6245,9 +5543,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_login` form](/docs/api/liquid/tags/form#form-customer_login).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -6263,9 +5559,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6281,9 +5575,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address) always returns `true`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -6299,9 +5591,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6317,9 +5607,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6335,9 +5623,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`product` form](/docs/api/liquid/tags/form#form-product).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6353,9 +5639,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`product` form](/docs/api/liquid/tags/form#form-product).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6371,9 +5655,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6388,17 +5670,13 @@ ], "summary": "Information about a form created by a [`form` tag](/docs/api/liquid/tags/form).", "name": "form", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"address1\":\"12 Phoenix Feather Alley\",\"address2\":\"1\",\"author\":null,\"body\":null,\"city\":\"Calgary\",\"company\":null,\"country\":\"Canada\",\"email\":null,\"errors\":null,\"first_name\":\"Cornelius\",\"id\":\"new\",\"last_name\":\"Potionmaker\",\"password_needed?\":false,\"phone\":\"44 131 496 0905\",\"posted_successfully?\":true,\"province\":\"Alberta\",\"set_as_default_checkbox\":\"<input type='checkbox' id='address_default_address_new' name='address[default]' value='1'>\",\"zip\":\"T1X 0L4\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -6409,9 +5687,7 @@ "property": "fulfillment" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -6421,9 +5697,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6439,9 +5713,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -6457,9 +5729,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -6475,9 +5745,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6493,9 +5761,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -6511,9 +5777,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there's no tracking number, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6529,9 +5793,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there's no tracking number, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6546,17 +5808,13 @@ ], "summary": "An order [fulfillment](https://help.shopify.com/manual/orders/fulfillment), which includes information like the line items\nbeing fulfilled and shipment tracking.", "name": "fulfillment", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[4].line_items[0].fulfillment", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -6567,9 +5825,7 @@ "property": "value" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -6579,9 +5835,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6597,9 +5851,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -6615,9 +5867,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6633,9 +5883,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -6651,9 +5899,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the source is a [`file_reference` metafield](/apps/metafields/types), then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -6669,9 +5915,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6686,24 +5930,18 @@ ], "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": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product.metafields.information.disclaimers.value", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], + "parents": [], "template": [ "gift_card.liquid" ] @@ -6716,9 +5954,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -6734,9 +5970,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6752,9 +5986,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6770,9 +6002,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "customer", @@ -6788,9 +6018,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there is no recipient associated with the gift card, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "recipient", @@ -6806,9 +6034,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there is no message intended for the recipient, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6824,9 +6050,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the gift card does not have a scheduled date, then `nil` is returned.\n> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the date.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6842,9 +6066,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -6860,9 +6082,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -6878,9 +6098,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6896,9 +6114,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -6914,9 +6130,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> The page at this URL is rendered through the [`gift_card.liquid` template](/themes/architecture/templates/gift-card-liquid)\n> of the theme.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6932,9 +6146,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The name doesn't include the `gift_card.` prefix, or the `.liquid` file extension.\n\n If a custom template isn't assigned to the gift card, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6950,9 +6162,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there aren't any line item properties, then an [`EmptyDrop`](/docs/api/liquid/basics#emptydrop) is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -6968,9 +6178,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -6986,9 +6194,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7004,9 +6210,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "product", @@ -7022,9 +6226,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7039,17 +6241,13 @@ ], "summary": "A [gift card](https://help.shopify.com/manual/products/gift-card-products) that's been issued to a customer or a recipient.", "name": "gift_card", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"balance\":5000,\"code\":\"WCGX 7X97 K9HJ DFR8\",\"currency\":\"CAD\",\"customer\":{},\"enabled\":true,\"expired\":false,\"expires_on\":null,\"initial_value\":5000,\"last_four_characters\":\"DFR8\",\"message\":null,\"send_on\":null,\"pass_url\":\"https://polinas-potent-potions.myshopify.com/v1/passes/pass.com.shopify.giftcardnext/94af7fbe55d010130df8d8bc4a338d36/\",\"product\":{},\"properties\":{},\"qr_identifier\":\"shopify-giftcard-v1-3TKWJKJBM3X7PBRK\",\"recipient\":null,\"template_suffix\":null,\"url\":\"https://checkout.shopify.com/gift_cards/56174706753/0011c591fc720d0a51b80cdb694f969e\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -7152,9 +6350,7 @@ "property": "" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -7164,9 +6360,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image_presentation", @@ -7182,9 +6376,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7200,9 +6392,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7218,9 +6408,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7236,9 +6424,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7254,9 +6440,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7272,9 +6456,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`](/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": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -7290,9 +6472,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7335,9 +6515,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The `position` property is only available for images that are associated with a product. If you reference this property\non an image from another source, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7353,9 +6531,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -7371,9 +6547,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The `product_id` property is only available for images associated with a product. If you reference this property on\nan image from another source, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7389,9 +6563,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -7441,9 +6613,7 @@ "property": "presentation" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -7453,9 +6623,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "focal_point", @@ -7470,34 +6638,24 @@ ], "summary": "The presentation settings for an image.", "name": "image_presentation", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "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": [ @@ -7543,9 +6701,7 @@ "property": "line_items" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -7555,9 +6711,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`](/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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7573,9 +6727,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7591,9 +6743,7 @@ "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`](/docs/api/liquid/objects/line_item#line_item-final_price).", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7609,9 +6759,7 @@ "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`](/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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7627,9 +6775,7 @@ "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`](/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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7645,9 +6791,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Caution:\n> Not applicable for item component as discounts are applied to the parent line item.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -7663,9 +6807,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7681,9 +6823,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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7699,9 +6839,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7717,9 +6855,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7735,9 +6871,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "product", @@ -7753,9 +6887,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "variant", @@ -7771,9 +6903,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -7789,9 +6919,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "fulfillment", @@ -7807,9 +6935,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7825,9 +6951,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7870,9 +6994,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Unit prices are available only to stores located in Germany or France.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "unit_price_measurement", @@ -7888,9 +7010,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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> 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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -7906,9 +7026,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7924,9 +7042,7 @@ "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](/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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7942,9 +7058,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7960,9 +7074,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](/docs/api/liquid/objects/order), the line item title appears in the language that the customer checked out in.\nThe title can receive an override value from the [Cart Transform API](/docs/api/functions/reference/cart-transform#showing-overrides).\nOverrides take precedence over translations.\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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -7978,9 +7090,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -7996,9 +7106,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8014,9 +7122,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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8032,9 +7138,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8050,9 +7154,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Caution:\n> Not applicable for item component as discounts are applied to the parent line item.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -8068,9 +7170,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`](/docs/api/liquid/objects/line_item#line_item-discount_allocations).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -8086,9 +7186,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8104,9 +7202,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8149,9 +7245,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Line item keys are unique identifiers that consist of the following components separated by a colon:\n\n- The ID of the variant associated with the line item\n- A hash of unique characteristics of the line item.\n\nNote: Line item keys are not stable identifiers. The line item key will change as characteristics of the line item change. This includes, but is not limited to, properties and discount applications.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8167,9 +7261,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use this property with the [`weight_with_unit` filter](/docs/api/liquid/filters/weight_with_unit) to format the weight.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8185,9 +7277,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8203,9 +7293,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn more about how to use this property in your theme, refer to [Remove line items from the cart](/themes/architecture/templates/cart#remove-line-items-from-the-cart).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8221,9 +7309,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The image can come from one of the following sources:\n\n- The image of the variant associated with the line item\n- The featured image of the product associated with the line item, if there's no variant image", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -8239,9 +7325,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](/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": [ - - ], + "examples": [], "return_type": [ { "type": "selling_plan_allocation", @@ -8257,9 +7341,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This field is applicable for cart line item only.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -8275,9 +7357,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\nThis field is applicable for cart line item only and currently available for shops using Checkout Extensibility.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8292,17 +7372,13 @@ ], "summary": "A line in a cart, checkout, or order. Each line item represents a product variant.", "name": "line_item", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[4].line_items[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -8313,9 +7389,7 @@ "property": "links" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -8325,9 +7399,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](/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": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8343,9 +7415,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](/docs/api/liquid/filters/within) are treated as equal to a standard product\n> URL for the same product.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8361,9 +7431,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8379,9 +7447,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](/docs/api/liquid/filters/within) and standard product URLs are treated\n> the same.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8397,9 +7463,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8442,9 +7506,7 @@ "deprecated": false, "deprecation_reason": "", "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- [`metaobject`](docs/api/liquid/objects/metaobject)\n- [`page`](/docs/api/liquid/objects/page)\n- [`policy`](/docs/api/liquid/objects/policy)\n- [`product`](/docs/api/liquid/objects/product)", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -8460,9 +7522,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8478,9 +7538,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8512,6 +7570,12 @@ "description": "The link points to the [collection list page](/themes/architecture/templates/list-collections).", "array_value": "" }, + { + "type": "string", + "name": "customer_account_page_link", + "description": "The link points to a [customer account page](https://shopify.dev/docs/apps/build/customer-accounts/full-page-extensions).", + "array_value": "" + }, { "type": "string", "name": "frontpage_link", @@ -8562,9 +7626,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8580,9 +7642,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8597,34 +7657,24 @@ ], "summary": "A link in a [menu](https://help.shopify.com/manual/online-store/menus-and-links/drop-down-menus).", "name": "link", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "linklists.to_a[0].links[2]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "summary": "All of the [menus](https://help.shopify.com/manual/online-store/menus-and-links/drop-down-menus) in a store.", "name": "linklists", "examples": [ @@ -8662,9 +7712,7 @@ "property": "" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -8674,9 +7722,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -8692,9 +7738,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8710,9 +7754,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> There's a maximum of 3 levels.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8728,9 +7770,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -8745,17 +7785,13 @@ ], "summary": "A [menu](https://help.shopify.com/manual/online-store/menus-and-links/drop-down-menus) in a store.", "name": "linklist", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "linklists.to_a[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -8766,9 +7802,7 @@ "property": "parentloop" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -8778,9 +7812,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8823,9 +7855,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8841,9 +7871,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8859,9 +7887,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8877,9 +7903,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8895,9 +7919,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8913,9 +7935,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -8947,19 +7967,13 @@ "handle": "", "data_from_file": "{\"first\":true,\"index\":1,\"index0\":0,\"last\":false,\"length\":4,\"rindex\":3}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -8969,9 +7983,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -8987,9 +7999,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9005,9 +8015,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9023,9 +8031,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9041,9 +8047,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9059,9 +8063,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9077,9 +8079,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9095,9 +8095,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9113,9 +8111,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -9131,9 +8127,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -9149,9 +8143,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -9167,9 +8159,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -9184,27 +8174,19 @@ ], "summary": "Information about a parent [`tablerow` loop](/docs/api/liquid/tags/tablerow).", "name": "tablerowloop", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"col\":1,\"col0\":0,\"col_first\":true,\"col_last\":false,\"first\":true,\"index\":1,\"index0\":0,\"last\":false,\"length\":5,\"rindex\":5,\"rindex0\":4,\"row\":1}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -9214,9 +8196,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -9232,9 +8212,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -9250,9 +8228,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "market", @@ -9268,9 +8244,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "country", @@ -9286,9 +8260,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "shop_locale", @@ -9303,17 +8275,13 @@ ], "summary": "Information about the countries and languages that are available on a store.", "name": "localization", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "localization", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -9324,9 +8292,7 @@ "property": "location" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -9336,9 +8302,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9354,9 +8318,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -9372,9 +8334,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "address", @@ -9390,9 +8350,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the location's address isn't verified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9408,9 +8366,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the location's address isn't verified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9426,9 +8382,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -9443,17 +8397,13 @@ ], "summary": "A store [location](https://help.shopify.com/manual/locations).", "name": "location", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?variant=39897499729985", "handle": "product.selected_variant.store_availabilities[0].location", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -9468,9 +8418,7 @@ "property": "market" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -9480,9 +8428,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -9498,9 +8444,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -9516,9 +8460,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage\n> metafields](/apps/metafields/manage) or visit the [Shopify Help\n> Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -9533,17 +8475,13 @@ ], "summary": "A group of one or more regions of the world that a merchant is targeting for sales.", "name": "market", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "localization.market", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -9554,9 +8492,7 @@ "property": "value" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -9566,9 +8502,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -9596,9 +8530,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -9614,9 +8546,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -9631,17 +8561,13 @@ ], "summary": "A measurement from one of the following metafield types:\n\n- `dimension`\n- `volume`\n- `weight`", "name": "measurement", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/dandelion-milk", "handle": "product.metafields.details.milk_container_volume.value", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -9692,9 +8618,7 @@ "property": "metafields" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -9704,9 +8628,7 @@ "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=\"/docs/api/liquid/basics#string\">A string</a></td>\n </tr>\n <tr>\n <td>\n <code>rich_text_field</code>\n </td>\n <td>A field that supports headings, lists, links, bold, and italics</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>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": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -9722,9 +8644,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -9860,9 +8780,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about metafield types, refer to [Metafield types](/apps/metafields/types).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -9944,19 +8862,13 @@ "handle": "product.metafields.information.directions", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -9966,9 +8878,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -9984,9 +8894,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10018,9 +8926,7 @@ "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -10043,9 +8949,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "metaobject_system", @@ -10087,9 +8991,7 @@ "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -10100,9 +9002,7 @@ "property": "system" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -10112,9 +9012,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This is a free-form string that's defined when the metaobject definition is created.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10130,9 +9028,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10148,9 +9044,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10166,9 +9060,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Only set for metaobjects that have the `online_store` capability.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10200,9 +9092,7 @@ "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -10213,9 +9103,7 @@ "property": "media" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -10225,9 +9113,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -10243,9 +9129,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10261,9 +9145,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10306,9 +9188,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10324,9 +9204,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -10341,17 +9219,13 @@ ], "summary": "A 3D model uploaded as product media.", "name": "model", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/potion-bottle", "handle": "product.featured_media", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -10362,9 +9236,7 @@ "property": "" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -10374,9 +9246,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10392,9 +9262,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10410,9 +9278,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10427,17 +9293,13 @@ ], "summary": "A model source file.", "name": "model_source", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/potion-bottle", "handle": "product.featured_media.sources[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -10448,9 +9310,7 @@ "property": "value" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -10460,9 +9320,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "currency", @@ -10494,9 +9352,7 @@ "handle": "product.metafields.details.price_per_100g.value", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -10527,9 +9383,7 @@ "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`](/docs/api/liquid/objects/order#order-discount_applications).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "discount", @@ -10572,9 +9426,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10620,9 +9472,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use this property to output the cancellation reason on the storefront.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10638,9 +9488,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -10656,9 +9504,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10674,9 +9520,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -10692,9 +9536,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10710,9 +9552,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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10728,9 +9568,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10746,9 +9584,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "customer", @@ -10764,9 +9600,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -10782,9 +9616,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10800,9 +9632,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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10818,9 +9648,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10836,9 +9664,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -10854,9 +9680,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no email is associated with the order, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10872,9 +9696,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10938,12 +9760,8 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use this property to output the financial status on the storefront.", - "examples": [ - - ], - "return_type": [ - - ], + "examples": [], + "return_type": [], "summary": "The localized version of the [financial status](/docs/api/liquid/objects/order#order-financial_status) of the order.", "name": "financial_status_label" }, @@ -10951,9 +9769,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -10969,9 +9785,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use this property to output the fulfillment status on the storefront.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11011,12 +9825,10 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { - "type": "string", + "type": "number", "name": "", "description": "", "array_value": "" @@ -11029,9 +9841,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -11047,9 +9857,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11065,9 +9873,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there's no note on the order, then `nil` is returned.\n> Tip:\n> Notes are [collected with the cart](https://shopify.dev/themes/architecture/templates/cart#support-cart-notes-and-attributes).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11083,9 +9889,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11101,9 +9905,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11119,9 +9921,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11137,9 +9937,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The new customer accounts includes a list of Buyers Orders and an Order Details View.\nThis liquid function exposes a URL to a specific Orders Details in new customer accounts.\n[Setup process for the new order details page](https://help.shopify.com/en/manual/customers/customer-accounts/new-customer-accounts)\ncan be found in the help center.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11155,9 +9953,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11173,9 +9969,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "address", @@ -11191,9 +9985,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "address", @@ -11209,9 +10001,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The tags are returned in alphabetical order.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11227,9 +10017,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11245,9 +10033,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11263,9 +10049,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11281,9 +10065,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> These line items are used to calculate the the [subtotal price](/docs/api/liquid/objects/order#order-subtotal_price).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11299,9 +10081,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11317,9 +10097,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11335,9 +10113,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11353,9 +10129,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11371,9 +10145,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11389,9 +10161,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11407,9 +10177,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -11424,17 +10192,13 @@ ], "summary": "An [order](https://help.shopify.com/manual/orders).", "name": "order", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[4]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -11461,9 +10225,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11479,9 +10241,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11497,9 +10257,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11515,9 +10273,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11533,9 +10289,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The name doesn't include the `page.` prefix, or the file extension (`.json` or `.liquid`).\n\n If a custom template isn't assigned to the page, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11551,9 +10305,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11569,9 +10321,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11587,9 +10337,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -11605,9 +10353,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11622,27 +10368,19 @@ ], "summary": "A [page](https://help.shopify.com/manual/online-store/themes/theme-structure/pages) on a store.", "name": "page", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/pages/about-us", "handle": "page", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -11652,9 +10390,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11670,9 +10406,7 @@ "deprecated": false, "deprecation_reason": "", "description": "For example, if you show 5 items per page and are on page 3, then the value of `paginate.current_offset` is 10.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11688,9 +10422,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11706,9 +10438,7 @@ "deprecated": false, "deprecation_reason": "", "description": "For example, if you paginate a collection of 120 products, then the value of `paginate.items` is 120.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11724,9 +10454,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Pagination parts are used to build pagination navigation.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11742,9 +10470,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "part", @@ -11760,9 +10486,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "part", @@ -11778,9 +10502,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11796,9 +10518,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The default value is `page`.\n\nIf you paginate over an array defined in a setting or a metafield list type, then a unique key is appended to page to allow the paginated list to\noperate independently from other lists on the page. For example, a paginated list defined in a setting might use the key\n`page_a9e329dc`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11813,27 +10533,19 @@ ], "summary": "Information about the pagination inside a set of [`paginate` tags](/docs/api/liquid/tags/paginate).", "name": "paginate", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"current_offset\":10,\"current_page\":3,\"items\":17,\"next\":{},\"page_param\":\"page\",\"page_size\":5,\"pages\":4,\"parts\":[],\"previous\":{}}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -11843,9 +10555,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -11861,9 +10571,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "predictive_search_resources", @@ -11879,9 +10587,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`highlight` filter](/docs/api/liquid/filters/highlight) to highlight the search terms in search results content.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -11897,9 +10603,7 @@ "deprecated": false, "deprecation_reason": "", "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 [`type` query parameter](/api/ajax/reference/predictive-search#query-parameters).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -11914,17 +10618,13 @@ ], "summary": "Information about the results from a predictive search query through the\n[Predictive Search API](/api/ajax/reference/predictive-search#get-locale-search-suggest).", "name": "predictive_search", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"performed\":true,\"resources\":{},\"terms\":\"potion\",\"types\":[]}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -11935,9 +10635,7 @@ "property": "price_adjustments" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -11947,9 +10645,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11965,9 +10661,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -11983,9 +10677,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12013,9 +10705,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12030,17 +10720,13 @@ ], "summary": "Information about how a selling plan changes the price of a variant for a given period of time.", "name": "selling_plan_price_adjustment", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?selling_plan=610435137", "handle": "product.selected_selling_plan.price_adjustments[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -12091,9 +10777,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12109,9 +10793,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -12127,9 +10809,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12145,9 +10825,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "taxonomy_category", @@ -12163,9 +10841,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Returns a maximum of 100 variants.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12181,9 +10857,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12199,9 +10873,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12217,9 +10889,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12235,9 +10905,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The name doesn't include the `product.` prefix, or the file extension (`.json` or `.liquid`).\n\nIf a custom template isn't assigned to the product, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12253,9 +10921,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12271,9 +10937,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This is the same value as [`product.content`](/docs/api/liquid/objects/product#product-content).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12289,9 +10953,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This is the same value as [`product.description`](/docs/api/liquid/objects/product#product-description).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12307,9 +10969,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -12325,9 +10985,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "media", @@ -12343,9 +11001,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12361,9 +11017,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12379,9 +11033,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12397,9 +11049,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12415,9 +11065,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12433,9 +11081,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -12451,9 +11097,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The selected variant is determined by the `variant` URL parameter. The `selected_variant` parameter is available on product pages only.\n\nFor a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 0.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "variant", @@ -12469,9 +11113,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Collections that aren't [available](https://help.shopify.com/manual/products/collections/make-collections-available) on\n> the Online Store sales channel aren't included.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12487,9 +11129,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no variant is currently selected, then `nil` is returned.\n\n> Note:\n> The selected variant is determined by the `variant` URL parameter. This URL parameter is available on product pages URLs only.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "variant", @@ -12505,9 +11145,7 @@ "deprecated": false, "deprecation_reason": "", "description": "For a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 0.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "variant", @@ -12523,9 +11161,7 @@ "deprecated": false, "deprecation_reason": "", "description": "For a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 0.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.\n- The variant has an associated [delivery profile](/docs/apps/selling-strategies/purchase-options/deferred/shipping-delivery/delivery-profiles) with a valid shipping rate.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -12568,9 +11204,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12586,9 +11220,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12604,9 +11236,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12622,9 +11252,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12640,9 +11268,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -12658,9 +11284,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If a product is [recommended](/docs/themes/product-merchandising/recommendations), then the URL contains tracking parameters:\n\n```liquid\n/products/gorgeous-wooden-computer?pr_choice=default&pr_prod_strat=description&pr_rec_pid=13&pr_ref_pid=17&pr_seq=alternating\n```", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12676,9 +11300,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The tags are returned in alphabetical order.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12694,9 +11316,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12712,9 +11332,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12757,9 +11375,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -12775,9 +11391,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -12793,9 +11407,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -12811,9 +11423,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no selling plan is selected, then `nil` is returned.\n\n> Note:\n> The selected selling plan is determined by the `selling_plan` URL parameter.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "selling_plan", @@ -12829,9 +11439,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no variant and selling plan are selected, then `nil` is returned.\n\n> Note:\n> The selected variant is determined by the `variant` URL parameter, and the selected selling plan is determined by the\n> `selling_plan` URL parameter.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "selling_plan_allocation", @@ -12847,9 +11455,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The following logic is used to determine which selling plan allocation is returned:\n\n| Selling plan allocation | Return criteria |\n| --- | --- |\n| The currently selected allocation | Returned if a variant and selling plan are selected.<br><br>The selected variant is determined by the `variant` URL parameter, and the selected selling plan is determined by the `selling_plan` URL parameter. |\n| The first allocation on the first available variant | Returned if no allocation is currently selected. |\n| The first allocation on the first variant | Returned if no allocation is currently selected, and there are no available variants. |\n\nIf the product doesn't have any selling plans, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "selling_plan_allocation", @@ -12865,9 +11471,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -12882,17 +11486,13 @@ ], "summary": "A [product](https://help.shopify.com/manual/products) in the store.", "name": "product", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -12903,9 +11503,7 @@ "property": "options_with_values" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -12915,9 +11513,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12933,9 +11529,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -12951,9 +11545,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -12969,9 +11561,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no value is currently selected, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -12986,17 +11576,13 @@ ], "summary": "A product option, such as size or color.", "name": "product_option", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product.options_with_values[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -13011,9 +11597,7 @@ "property": "options" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -13023,9 +11607,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13041,9 +11623,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13059,9 +11639,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "swatch", @@ -13077,9 +11655,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13095,9 +11671,7 @@ "deprecated": false, "deprecation_reason": "", "description": "In the context of the selected values for previous options, indicates whether the current option value has any purchaseable combinations in any subsequent options, or whether the current option value is purchaseable if there are no subsequent options.\nFor example, if a product comes in Color/Size/Material and Red/Small/Cotton is selected, `available` will indicate:\n- Color: Whether any variants for the Color option value are available for purchase.\n- Size: Whether any variants for Color:Red and the Size option value are available for purchase.\n- Material: Whether any variants for Color:Red, Size:Small, and the Material option value are available for purchase.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13113,9 +11687,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If this option value is selected (`selected == true`), this returns the `selected_or_first_available_variant`.\n\nIf this option value is not selected (`selected == false`), this returns the variant that is associated with the current\noption value and the other currently selected option values.\n\nUsing optionValue.variant is the recommended way to render product option values availability.\nFor more information, refer to [rendering option value availability.](https://shopify.dev/docs/storefronts/themes/product-merchandising/variants/support-high-variant-products#option-value-availability)", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "variant", @@ -13131,9 +11703,7 @@ "deprecated": false, "deprecation_reason": "", "description": "```liquid\n/products/gorgeous-wooden-computer\n```", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13148,17 +11718,13 @@ ], "summary": "A product option value, such as \"red\" for the option \"color\".", "name": "product_option_value", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/mana-potion", "handle": "product.options_with_values[0].values[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -13173,9 +11739,7 @@ "property": "swatch" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -13185,9 +11749,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "color", @@ -13203,9 +11765,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -13220,17 +11780,13 @@ ], "summary": "Color and image for visual representation.\nAvailable for [product option values](/docs/api/liquid/objects/product_option_value) and [filter values](/docs/api/liquid/objects/filter_value).", "name": "swatch", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/mana-potion", "handle": "product.options_with_values[0].values[0].swatch", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -13261,9 +11817,7 @@ "property": "variant" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -13273,9 +11827,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -13291,9 +11843,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "product", @@ -13309,9 +11859,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The selected variant is determined by the `variant` URL parameter. This URL parameter is available on product pages URLs only.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13327,9 +11875,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13338,16 +11884,14 @@ "array_value": "" } ], - "summary": "Returns `true` if the variant has been matched by a [storefront filter](https://shopify.dev/themes/navigation-search/filtering/storefront-filtering).\nReturns `false` if it hasn't.", + "summary": "Returns `true` if the variant has been matched by a [storefront filter](https://shopify.dev/themes/navigation-search/filtering/storefront-filtering)\nor no filters are applied.\nReturns `false` if it hasn't.", "name": "matched" }, { "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13390,9 +11934,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no rule exists, then a default value is returned.\n\nThis rule can be set as part of a [B2B catalog](https://help.shopify.com/manual/b2b/catalogs/quantity-pricing).\n\n> Note:\n> The default quantity rule is `min=1,max=null,increment=1`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "quantity_rule", @@ -13408,9 +11950,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -13426,9 +11966,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13444,9 +11982,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13462,9 +11998,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13480,9 +12014,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no selling plan is selected, then `nil` is returned.\n\n> Note:\n> The selected selling plan is determined by the `selling_plan` URL parameter.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "selling_plan_allocation", @@ -13498,9 +12030,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -13516,9 +12046,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13534,9 +12062,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13552,9 +12078,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13597,9 +12121,7 @@ "deprecated": true, "deprecation_reason": "Deprecated. Prefer to use [`variant.options`](/docs/api/liquid/objects/variant#variant-options) instead.", "description": "If there's no first product option, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13615,9 +12137,7 @@ "deprecated": true, "deprecation_reason": "Deprecated. Prefer to use [`variant.options`](/docs/api/liquid/objects/variant#variant-options) instead.", "description": "If there's no second product option, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13633,9 +12153,7 @@ "deprecated": true, "deprecation_reason": "Deprecated. Prefer to use [`variant.options`](/docs/api/liquid/objects/variant#variant-options) instead.", "description": "If there's no third product option, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13651,9 +12169,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Variant URLs use the following structure:\n\n```\n/products/[product-handle]?variant=[variant-id]\n```", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13669,9 +12185,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](/docs/api/liquid/filters/weight_with_unit).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13687,9 +12201,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](/docs/api/liquid/filters/weight_with_unit).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13705,9 +12217,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`weight_with_unit`](/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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13723,9 +12233,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> Unit prices are available only to stores located in Germany and France.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "unit_price_measurement", @@ -13741,9 +12249,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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> 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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13759,9 +12265,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If inventory isn't tracked, then the number of items sold is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -13777,9 +12281,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If inventory isn't tracked, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13795,9 +12297,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about why merchants might want to continue selling products when they're out of stock, visit the\n> [Shopify Help Center](https://help.shopify.com/manual/products/inventory/getting-started-with-inventory/selling-when-out-of-stock).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13819,9 +12319,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13837,9 +12335,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13855,9 +12351,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This is the same value as [`variant.image`](/docs/api/liquid/objects/variant#variant-image).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -13873,9 +12367,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> This is the same value as [`variant.featured_image`](/docs/api/liquid/objects/variant#variant-featured_image).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -13891,9 +12383,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "media", @@ -13909,9 +12399,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Incoming inventory information is populated by [inventory transfers](https://help.shopify.com/manual/products/inventory/transfers),\n[purchase orders](https://help.shopify.com/manual/products/inventory/purchase-orders), and\n[third-party apps](/docs/apps/fulfillment/inventory-management-apps).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13927,9 +12415,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Incoming inventory information is populated by [inventory transfers](https://help.shopify.com/manual/products/inventory/transfers),\n[purchase orders](https://help.shopify.com/manual/products/inventory/purchase-orders), and\n[third-party apps](/docs/apps/fulfillment/inventory-management-apps).\n\n> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the date.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -13945,9 +12431,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The array is defined in only the following cases:\n\n- `variant.selected` is `true`\n- The variant is the product's first available variant. For example, `product.first_available_variant` or `product.selected_or_first_available_variant`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -13963,9 +12447,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -13980,17 +12462,13 @@ ], "summary": "A [product variant](https://help.shopify.com/manual/products/variants).", "name": "variant", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product.variants[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -14001,9 +12479,7 @@ "property": "quantity_price_breaks" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -14013,9 +12489,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -14031,9 +12505,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is the price 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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -14048,17 +12520,13 @@ ], "summary": "The per-unit price of a variant when purchasing the minimum quantity or more.", "name": "quantity_price_break", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"minimum_quantity\":\"10\",\"price\":\"20.00\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -14069,9 +12537,7 @@ "property": "value" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -14081,9 +12547,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -14099,9 +12563,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -14117,9 +12579,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -14134,17 +12594,13 @@ ], "summary": "Information for a [`rating` type](/apps/metafields/types) metafield.", "name": "rating", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product.metafields.details.rating.value", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -14167,9 +12623,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14185,9 +12639,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14203,9 +12655,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14220,27 +12670,19 @@ ], "summary": "A recipient that is associated with a [gift card](https://help.shopify.com/manual/products/gift-card-products).", "name": "recipient", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"email\":\"cornelius.potionmaker@gmail.com\",\"name\":\"Cornelius Potionmaker\",\"nickname\":\"Cornelius\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -14250,9 +12692,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -14268,9 +12708,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If `performed?` is `false`, then an [EmptyDrop](/docs/api/liquid/basics#emptydrop) is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -14286,9 +12724,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If `performed?` is `false`, then 0 is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -14304,9 +12740,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If `performed?` is `false`, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14321,27 +12755,19 @@ ], "summary": "Product recommendations for a specific product based on sales data, product descriptions, and collection relationships.", "name": "recommendations", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"products\":[],\"products_count\":4,\"performed?\":true}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -14351,9 +12777,7 @@ "deprecated": false, "deprecation_reason": "", "description": "You can use `request.design_mode` to control theme behavior depending on whether the theme is being viewed in the editor.\nFor example, you can prevent session data from being tracked by tracking scripts in the theme editor.\n\n> Caution:\n> You shouldn't use `request.design_mode` to change customer-facing functionality. The theme editor preview should match\n> what the merchant's customers see on the live store.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -14369,9 +12793,7 @@ "deprecated": false, "deprecation_reason": "", "description": "You can use `request.visual_preview_mode` to control theme behavior depending on whether the theme is being viewed in the editor's visual section preview.\nFor example, you can remove any scripts that interefere with how the section is displayed.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -14387,9 +12809,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14531,9 +12951,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14576,9 +12994,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> If the current path is for a page that doesn't exist, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14594,9 +13010,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "shop_locale", @@ -14611,24 +13025,18 @@ ], "summary": "Information about the current URL and the associated page.", "name": "request", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "request", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], + "parents": [], "template": [ "robots.txt.liquid" ] @@ -14641,9 +13049,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -14658,17 +13064,13 @@ ], "summary": "The default rule groups for the `robots.txt` file.", "name": "robots", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/robots.txt", "handle": "robots", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -14679,9 +13081,7 @@ "property": "default_groups" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -14691,9 +13091,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "user_agent", @@ -14709,9 +13107,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -14727,9 +13123,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If the group doesn't require a sitemap, then `blank` is returned.\n\nThe sitemap can be accessed at `/sitemap.xml`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "sitemap", @@ -14744,17 +13138,13 @@ ], "summary": "A group of rules for the `robots.txt` file.", "name": "group", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/robots.txt", "handle": "robots.default_groups[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -14765,9 +13155,7 @@ "property": "rules" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -14777,9 +13165,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14795,9 +13181,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14812,27 +13196,19 @@ ], "summary": "A rule for the `robots.txt` file, which tells crawlers which pages can, or can't, be accessed.", "name": "rule", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/robots.txt", "handle": "robots.default_groups[0].rules[27]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -14842,9 +13218,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14860,9 +13234,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14878,9 +13250,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14896,9 +13266,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14914,9 +13282,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14932,9 +13298,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14950,9 +13314,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14968,9 +13330,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -14986,9 +13346,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The all-products collection is automatically generated by Shopify and contains all products in the store.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15004,9 +13362,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15022,9 +13378,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to support predictive search in your theme, refer to [Add predictive search to your theme](/themes/navigation-search/search/predictive-search).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15040,9 +13394,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15058,9 +13410,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15076,9 +13426,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15094,9 +13442,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15112,9 +13458,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15130,9 +13474,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15148,9 +13490,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15165,17 +13505,13 @@ ], "summary": "Allows you to generate standard URLs for the storefront.", "name": "routes", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "routes", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -15186,9 +13522,7 @@ "property": "cart_calculate_line_items" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -15198,9 +13532,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15216,9 +13548,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15233,24 +13563,18 @@ ], "summary": "Information about a Shopify Script.\n> Caution:\n> Shopify Scripts will be sunset on August 28, 2025. Migrate your existing scripts to [Shopify Functions](/docs/api/functions) before this date.", "name": "script", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "scripts.cart_calculate_line_items", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], + "parents": [], "template": [ "search" ] @@ -15263,9 +13587,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`highlight` filter](/docs/api/liquid/filters/highlight) to highlight the search terms in search result content.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15281,9 +13603,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Only filters that are relevant to the current search results are returned. If the search results contain more than 1000\nproducts, then the array will be empty.\n\n> Tip:\n> To learn about how to set up filters in the admin, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -15299,9 +13619,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -15344,9 +13662,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15389,12 +13705,8 @@ "deprecated": false, "deprecation_reason": "", "description": "If there's no `sort_by` URL parameter, then the value is `nil`.", - "examples": [ - - ], - "return_type": [ - - ], + "examples": [], + "return_type": [], "summary": "The sort order of the search results. This is determined by the `sort_by` URL parameter.", "name": "sort_by" }, @@ -15402,9 +13714,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15420,9 +13730,7 @@ "deprecated": false, "deprecation_reason": "", "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 [`type` query parameter](/api/ajax/reference/predictive-search#query-parameters).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -15437,27 +13745,19 @@ ], "summary": "Information about a storefront search query.", "name": "search", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/search?q=potion", "handle": "search", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": false, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -15467,9 +13767,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The ID for sections included through [JSON templates](/themes/architecture/templates/json-templates) are dynamically\ngenerated by Shopify.\n\nThe ID for static sections is the section file name without the `.liquid` extension. For example, a `header.liquid`\nsection has an ID of `header`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15485,9 +13783,7 @@ "deprecated": false, "deprecation_reason": "", "description": "To learn about how to access settings, refer to [Access settings](/themes/architecture/settings#access-settings).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -15503,9 +13799,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Use this property to adjust section behavior based on its position within its location ([template](/docs/themes/architecture/templates), [section group](/docs/themes/architecture/section-groups)) and on the page. The `index` starts at 1 within each location.\n\nAn example use case is for programmatically setting `loading=\"lazy\"` for images below the fold based on an index higher than, for example, 3. Note that this is now the default behavior for the [`image_tag` filter](/docs/api/liquid/filters#image_tag).\n\nOnly use this for non-display use cases like web performance. Because of various limitations, the `index` property returns `nil` in the following contexts:\n\n- When rendered as a [static section](/docs/themes/architecture/sections#statically-render-a-section)\n- While rendering in the online store editor\n- When using the [Section Rendering API](/docs/api/section-rendering)", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15521,9 +13815,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This is the same as the `index` property except that the index starts at 0 instead of 1.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15539,9 +13831,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Sections can have one of four different location types. For sections rendered within a [template](/docs/themes/architecture/templates), the location will be `template`. For sections rendered within a [section group](/docs/themes/architecture/section-groups), the location will be the section group type, e.g., `header`, `footer`, `custom.<type>`. Sections [rendered statically](/docs/themes/architecture/sections#statically-render-a-section) will be `static`. Finally, if you're still using `content_for_index`, then the value will be `content_for_index`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15557,9 +13847,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -15574,17 +13862,13 @@ ], "summary": "The properties and settings of a section.", "name": "section", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"blocks\":[],\"id\":\"template--14453298921537__cart-items\",\"settings\":{}}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -15611,9 +13895,7 @@ "property": "selected_selling_plan_allocation" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -15623,9 +13905,7 @@ "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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15641,9 +13921,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value of the **compare at** price is the line item's price without the selling plan applied.\n\nThe value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15659,9 +13937,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`](/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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -15677,9 +13953,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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15695,9 +13969,7 @@ "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15713,9 +13985,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "selling_plan", @@ -15731,9 +14001,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15749,9 +14017,7 @@ "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": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15767,9 +14033,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15784,17 +14048,13 @@ ], "summary": "Information about how a specific [selling plan](/apps/subscriptions/selling-plans) affects a line item.", "name": "selling_plan_allocation", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?variant=39897499828289&selling_plan=610435137", "handle": "product.selected_selling_plan_allocation", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -15805,9 +14065,7 @@ "property": "price_adjustments" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -15817,9 +14075,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15835,9 +14091,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15852,17 +14106,13 @@ ], "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": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?variant=39897499828289&selling_plan=610435137", "handle": "product.selected_selling_plan_allocation.price_adjustments[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -15881,9 +14131,7 @@ "property": "checkout_charge" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -15893,9 +14141,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -15917,9 +14163,7 @@ "deprecated": false, "deprecation_reason": "", "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\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15934,17 +14178,13 @@ ], "summary": "Information about how a specific [selling plan](/apps/subscriptions/selling-plans) affects the amount that a\ncustomer needs to pay for a line item at checkout.", "name": "selling_plan_checkout_charge", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?selling_plan=610435137", "handle": "product.selected_selling_plan.checkout_charge", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -15967,9 +14207,7 @@ "property": "selling_plan" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -15979,9 +14217,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -15997,9 +14233,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The name is shown at checkout with the line item summary.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16015,9 +14249,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16033,9 +14265,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The name is shown at checkout with the line item summary.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16051,9 +14281,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -16069,9 +14297,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16087,9 +14313,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`](/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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16105,9 +14329,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The selected selling plan is determined by the `selling_plan` URL parameter.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -16123,9 +14345,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "selling_plan_checkout_charge", @@ -16140,17 +14360,13 @@ ], "summary": "Information about the intent of how a specific [selling plan](/apps/subscriptions/selling-plans) affects a line item.", "name": "selling_plan", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?selling_plan=610435137", "handle": "product.selected_selling_plan", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -16161,9 +14377,7 @@ "property": "" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -16173,9 +14387,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16191,9 +14403,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -16209,9 +14419,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16227,9 +14435,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](/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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16245,9 +14451,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16263,9 +14467,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The selected selling plan is determined by the `selling_plan` URL parameter.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -16280,17 +14482,13 @@ ], "summary": "Information about a specific group of [selling plans](/apps/subscriptions/selling-plans) that include any of a\nproduct's variants.", "name": "selling_plan_group", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product.selling_plan_groups[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -16301,9 +14499,7 @@ "property": "" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -16313,9 +14509,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16331,9 +14525,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -16349,9 +14541,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16367,9 +14557,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no selling plan is currently selected, then `nil` is returned.\n\n> Note:\n> The selected selling plan is determined by the `selling_plan` URL parameter.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16384,17 +14572,13 @@ ], "summary": "Information about a specific option in a [selling plan group](/docs/api/liquid/objects/selling_plan_group).", "name": "selling_plan_group_option", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product.selling_plan_groups[0].options[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -16405,9 +14589,7 @@ "property": "options" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -16417,9 +14599,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16435,9 +14615,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -16453,9 +14631,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16470,17 +14646,13 @@ ], "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": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?selling_plan=610435137", "handle": "product.selected_selling_plan.options[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -16495,9 +14667,7 @@ "property": "shipping_method" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -16507,9 +14677,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](/docs/api/liquid/objects/order), the shipping method title appears in the language that the customer checked out in.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16525,9 +14693,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -16543,9 +14709,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -16561,9 +14725,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because the price did not include order level discounts.\n\nThe `shipping_line.price` property has been replaced by [`shipping_line.price_with_discounts`](/docs/api/liquid/objects/shipping_method#shipping_method-price_with_discounts).", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -16579,9 +14741,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> The price of the shipping method is appended to handle.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16597,9 +14757,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16615,9 +14773,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16633,9 +14789,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16650,27 +14804,19 @@ ], "summary": "Information about the shipping method for an order.", "name": "shipping_method", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[1].shipping_method", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -16680,9 +14826,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16698,9 +14842,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16716,9 +14858,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16734,9 +14874,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> You can get the store's currency with [`shop.currency`](/docs/api/liquid/objects/shop#shop-currency).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16752,9 +14890,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16770,9 +14906,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`](/docs/api/liquid/objects/shop#shop-published_locales).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -16794,9 +14928,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](/docs/api/liquid/objects/request#request-locale).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "shop_locale", @@ -16812,9 +14944,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16830,9 +14960,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16848,9 +14976,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16866,9 +14992,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16884,9 +15008,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16902,9 +15024,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16920,9 +15040,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -16938,9 +15056,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "address", @@ -16956,9 +15072,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -16974,9 +15088,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -16992,9 +15104,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17010,9 +15120,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "currency", @@ -17028,9 +15136,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "currency", @@ -17046,12 +15152,8 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about how to create metafields, refer to [Create and manage metafields](/apps/metafields/manage) or visit\n> the [Shopify Help Center](https://help.shopify.com/manual/metafields).", - "examples": [ - - ], - "return_type": [ - - ], + "examples": [], + "return_type": [], "summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the store.", "name": "metafields" }, @@ -17059,9 +15161,7 @@ "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](/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": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -17077,9 +15177,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](/docs/api/liquid/objects/cart#cart-taxes_included).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -17095,9 +15193,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "policy", @@ -17113,9 +15209,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "policy", @@ -17131,9 +15225,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "policy", @@ -17149,9 +15241,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "policy", @@ -17167,9 +15257,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "policy", @@ -17266,9 +15354,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -17284,9 +15370,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -17302,9 +15386,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -17320,9 +15402,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "brand", @@ -17338,29 +15418,21 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], + "return_type": [], "summary": "All of the [metaobjects](/docs/api/liquid/objects/metaobject) of the store.", "name": "metaobjects" } ], "summary": "Information about the store, such as the store address, the total number of products, and various settings.", "name": "shop", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "shop", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -17387,9 +15459,7 @@ "property": "locale" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -17399,9 +15469,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17417,9 +15485,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17435,9 +15501,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17453,9 +15517,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -17471,9 +15533,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17488,17 +15548,13 @@ ], "summary": "A language in a store.", "name": "shop_locale", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "shop.published_locales[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -17529,9 +15585,7 @@ "property": "subscription_policy" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -17541,9 +15595,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17559,9 +15611,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17577,9 +15627,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17595,9 +15643,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17612,17 +15658,13 @@ ], "summary": "A [store policy](https://help.shopify.com/manual/checkout-settings/refund-privacy-tos), such as a privacy or return policy.", "name": "policy", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "shop.policies[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -17633,9 +15675,7 @@ "property": "store_availabilities" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -17645,9 +15685,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -17663,9 +15701,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -17681,9 +15717,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> This value can be configured in the Shopify admin. To learn more, visit the [Shopify Help Center](https://help.shopify.com/en/manual/sell-in-person/shopify-pos/order-management/local-pickup-for-online-orders#manage-preferences-for-a-local-pickup-location).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17699,9 +15733,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "location", @@ -17716,17 +15748,13 @@ ], "summary": "A variant's inventory information for a physical store location.", "name": "store_availability", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion?variant=39897499729985", "handle": "product.selected_variant.store_availabilities[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -17741,9 +15769,7 @@ "property": "tax_lines" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -17753,9 +15779,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17771,9 +15795,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -17789,9 +15811,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -17807,9 +15827,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -17824,17 +15842,13 @@ ], "summary": "Information about a tax line of a checkout or order.", "name": "tax_line", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"price\":1901,\"rate\":0.05,\"rate_percentage\":5.0,\"title\":\"GST\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -17845,9 +15859,7 @@ "property": "category" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -17857,9 +15869,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17875,9 +15885,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17893,9 +15901,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17911,9 +15917,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -17928,27 +15932,19 @@ ], "summary": "The taxonomy category for a product", "name": "taxonomy_category", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "product.category", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": true, "deprecation_reason": "Deprecated because the values of this object's properties are subject to change, so can't be relied on within the theme.\n\nIf you want to link to the theme editor for the published theme, then you can use the URL path `/admin/themes/current/editor`.\n\nWhile this object is deprecated in Liquid and shouldn't be used, you can still access it through the [REST Admin API](/api/admin-rest/current/resources/theme).", @@ -17958,9 +15954,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -17976,9 +15970,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -17994,9 +15986,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18029,34 +16019,24 @@ ], "summary": "Information about the current theme.", "name": "theme", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "theme", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> To learn about the available setting types, refer to [Input settings](/themes/architecture/settings/input-settings).", - "properties": [ - - ], + "properties": [], "summary": "Allows you to access all of the theme's settings from the [`settings_schema.json` file](/themes/architecture/config/settings-schema-json).", "name": "settings", "examples": [ @@ -18076,19 +16056,13 @@ "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -18098,9 +16072,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18224,9 +16196,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Returns `nil` if the default template is being used.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18242,9 +16212,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Returns `nil` if the template's parent directory is `/templates`.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18259,17 +16227,13 @@ ], "summary": "Information about the current [template](/docs/themes/architecture/templates).", "name": "template", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/health-potion", "handle": "template", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -18284,9 +16248,7 @@ "property": "transactions" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -18296,9 +16258,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -18314,9 +16274,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18332,9 +16290,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18368,9 +16324,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18386,9 +16340,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This includes things like whether the payment was a test, or an authorization code if there was one.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18404,9 +16356,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18446,9 +16396,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18464,9 +16412,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18482,9 +16428,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "transaction_payment_details", @@ -18500,9 +16444,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The amount is in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -18518,9 +16460,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18536,9 +16476,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -18554,9 +16492,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18572,9 +16508,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -18589,17 +16523,13 @@ ], "summary": "A transaction associated with a checkout or order.", "name": "transaction", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[1].transactions[0]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -18614,9 +16544,7 @@ "property": "unit_price_measurement" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -18626,9 +16554,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18656,9 +16582,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -18674,9 +16598,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18692,9 +16614,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -18710,9 +16630,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18727,17 +16645,13 @@ ], "summary": "Information about how units of a product variant are measured. It's used to calculate\n[unit prices](https://help.shopify.com/manual/intro-to-shopify/initial-setup/sell-in-france/price-per-unit#add-unit-prices-to-your-product).", "name": "unit_price_measurement", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[1].line_items[0].unit_price_measurement", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -18748,9 +16662,7 @@ "property": "user" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -18760,9 +16672,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -18778,9 +16688,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no bio is specified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18796,9 +16704,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18814,9 +16720,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18832,9 +16736,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no personal website is specified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18850,9 +16752,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no image is specified, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -18868,9 +16768,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18886,9 +16784,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -18903,17 +16799,13 @@ ], "summary": "The author of a blog article.", "name": "user", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/blogs/potion-notions/how-to-tell-if-you-have-run-out-of-invisibility-potion", "handle": "article.user", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -18928,9 +16820,7 @@ "property": "media" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -18940,9 +16830,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -18958,9 +16846,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -18976,9 +16862,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -18994,9 +16878,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19012,9 +16894,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19057,9 +16937,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19075,9 +16953,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "image", @@ -19092,17 +16968,13 @@ ], "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": [ - - ], + "examples": [], "json_data": { "path": "/products/potion-beats", "handle": "product.media[1]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -19113,9 +16985,7 @@ "property": "sources" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -19125,9 +16995,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19143,9 +17011,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Note:\n> When mp4 videos are uploaded, Shopify generates an m3u8 file as an additional video source. An m3u8 file enables video\n> players to leverage HTTP live streaming (HLS), resulting in an optimized video experience based on the user's internet\n> connection.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19173,9 +17039,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19191,9 +17055,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19209,9 +17071,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19226,39 +17086,27 @@ ], "summary": "Information about the source files for a video.", "name": "video_source", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/products/potion-beats", "handle": "product.media[1].sources[1]", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "properties": [], "summary": "Returns `true` if a store has any payment providers with offsite checkouts, such as PayPal Express Checkout.", "name": "additional_checkout_buttons", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -19276,19 +17124,13 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "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](/docs/api/liquid/objects/country_option_tags).", - "properties": [ - - ], + "properties": [], "summary": "Creates an `<option>` tag for each country.", "name": "all_country_option_tags", "examples": [ @@ -19320,24 +17162,16 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "To learn about canonical URLs, refer to [Google's documentation](https://support.google.com/webmasters/answer/139066?hl=en).", - "properties": [ - - ], + "properties": [], "summary": "The canonical URL for the current page.", "name": "canonical_url", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -19355,9 +17189,7 @@ { "access": { "global": false, - "parents": [ - - ], + "parents": [], "template": [ "checkout" ] @@ -19370,9 +17202,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19388,9 +17218,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Shopify Plus merchants that have access to `checkout.liquid` can [capture attributes at checkout](/themes/architecture/layouts/checkout-liquid#capture-checkout-attributes).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "untyped", @@ -19406,9 +17234,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "address", @@ -19424,9 +17250,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -19442,9 +17266,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because `false` is always returned.", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -19460,9 +17282,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19478,9 +17298,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19496,9 +17314,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "customer", @@ -19514,9 +17330,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because an unsaved discount doesn't exist on the [**Order status** page](https://help.shopify.com/manual/orders/status-tracking).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "discount", @@ -19532,9 +17346,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`](/docs/api/liquid/objects/checkout#checkout-discount_applications).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19550,9 +17362,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19568,9 +17378,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19586,9 +17394,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19604,9 +17410,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19622,9 +17426,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because `nil` is always returned.", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19640,9 +17442,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because `nil` is always returned.", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19658,9 +17458,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because the array is always empty.", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19676,9 +17474,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because `unfulfilled` is always returned.", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19694,9 +17490,7 @@ "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 amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19712,9 +17506,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19730,9 +17522,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19748,9 +17538,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19766,9 +17554,7 @@ "deprecated": false, "deprecation_reason": "", "description": "This value is the same as [`checkout.id`](/docs/api/liquid/objects/checkout#checkout-id) with a `#` prepended to it.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19784,9 +17570,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19802,9 +17586,7 @@ "deprecated": false, "deprecation_reason": "", "description": "Depending on the payment provider, the order might not have been created when the [**Thank you** page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.\n> Note:\n> The `order` object isn't available on the **Thank you** page.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "order", @@ -19820,9 +17602,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19838,9 +17618,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19856,9 +17634,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -19874,9 +17650,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -19892,9 +17666,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "address", @@ -19910,9 +17682,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "shipping_method", @@ -19928,9 +17698,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19946,9 +17714,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -19964,9 +17730,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -19982,9 +17746,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -20000,9 +17762,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -20018,9 +17778,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because the array is always empty.", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -20036,9 +17794,7 @@ "deprecated": true, "deprecation_reason": "Deprecated because the array is always the same as [`checkout.line_items`](/docs/api/liquid/objects/checkout#checkout-line_items).", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -20054,9 +17810,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -20071,17 +17825,13 @@ ], "summary": "A customer's checkout.", "name": "checkout", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"applied_gift_cards\":[],\"attributes\":{},\"billing_address\":{},\"buyer_accepts_marketing\":false,\"cart_level_discount_applications\":[],\"currency\":\"CAD\",\"customer\":{},\"discount_applications\":[],\"discounts_amount\":4224,\"discounts_savings\":-4224,\"email\":\"cornelius.potionmaker@gmail.com\",\"gift_cards_amount\":0,\"id\":29944051400769,\"line_items\":[],\"line_items_subtotal_price\":42249,\"name\":\"#29944051400769\",\"note\":null,\"order\":null,\"order_id\":null,\"order_name\":\"#29944051400769\",\"order_number\":\"#29944051400769\",\"requires_shipping\":true,\"shipping_address\":{},\"shipping_method\":{},\"shipping_price\":0,\"tax_lines\":[],\"tax_price\":0,\"total_price\":38025,\"transactions\":[]}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -20092,9 +17842,7 @@ "property": "comments" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -20104,9 +17852,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20122,9 +17868,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20140,9 +17884,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20158,9 +17900,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20176,9 +17916,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -20194,9 +17932,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](/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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20212,9 +17948,7 @@ "deprecated": false, "deprecation_reason": "", "description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20230,9 +17964,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20247,39 +17979,27 @@ ], "summary": "An article comment.", "name": "comment", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"author\":\"Cornelius\",\"content\":\"Wow, this is going to save me a fortune in invisibility potion!\",\"created_at\":\"2022-06-05 19:33:57 -0400\",\"email\":\"cornelius.potionmaker@gmail.com\",\"id\":129089273921,\"status\":\"published\",\"updated_at\":\"2022-06-05 19:33:57 -0400\",\"url\":\"/blogs/potion-notions/how-to-tell-if-you-have-run-out-of-invisibility-potion#129089273921\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "properties": [], "summary": "Returns checkout buttons for any active payment providers with offsite checkouts.", "name": "content_for_additional_checkout_buttons", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20297,24 +18017,16 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "If you use a [Liquid index template](/themes/architecture/templates/index-template) (`templates/index.liquid`), then you must include `{{ content_for_index }}` in the template. This object can't be used in JSON index templates.", - "properties": [ - - ], + "properties": [], "summary": "Dynamically returns the content of [sections](/themes/architecture/sections) to be rendered on the home page.", "name": "content_for_index", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20332,24 +18044,16 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "Include the `content_for_layout` object in your [layout files](/themes/architecture/layouts) between the `<body>` and\n`</body>` HTML tags.\n\n> Note:\n> The `content_for_layout` object is required in `theme.liquid`.", - "properties": [ - - ], + "properties": [], "summary": "Dynamically returns content based on the current [template](/themes/architecture/templates).", "name": "content_for_layout", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20367,19 +18071,13 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "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`](/docs/api/liquid/objects/all_country_option_tags).", - "properties": [ - - ], + "properties": [], "summary": "Creates an `<option>` tag for each country and region that's included in a shipping zone on the [Shipping](https://www.shopify.com/admin/settings/shipping) page of the Shopify admin.", "name": "country_option_tags", "examples": [ @@ -20411,19 +18109,13 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "The `current_page` object has a value of 1 for non-paginated resources.", - "properties": [ - - ], + "properties": [], "summary": "The current page number.", "name": "current_page", "examples": [ @@ -20455,9 +18147,7 @@ { "access": { "global": false, - "parents": [ - - ], + "parents": [], "template": [ "blog", "collection" @@ -20466,14 +18156,10 @@ "deprecated": false, "deprecation_reason": "", "description": "You can [add tags](https://help.shopify.com/en/manual/shopify-admin/productivity-tools/using-tags) to articles and\nproducts. Article tags can be used to [filter a blog page](/themes/architecture/templates/blog#filter-articles-by-tag)\nto show only articles with specific tags. Similarly, product tags can be used to [filter a collection page](/themes/navigation-search/filtering/tag-filtering)\nto show only products with specific tags.", - "properties": [ - - ], + "properties": [], "summary": "The currently applied tags.", "name": "current_tags", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20497,9 +18183,7 @@ "property": "errors" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -20509,9 +18193,7 @@ "deprecated": false, "deprecation_reason": "", "description": "You can access a specific message in the array by using a specific error from the `form_errors` array as a key.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -20527,9 +18209,7 @@ "deprecated": false, "deprecation_reason": "", "description": "You can access a specific field in the array by using a specific error from the `form_errors` array as a key.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -20573,24 +18253,16 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "The `handle` object will return a value only when the following templates are being viewed:\n\n- [article](/themes/architecture/templates/article)\n- [blog](/themes/architecture/templates/blog)\n- [collection](/themes/architecture/templates/collection)\n- [page](/themes/architecture/templates/page)\n- [product](/themes/architecture/templates/product)\n\nIf none of the above templates are being viewed, then `nil` is returned.", - "properties": [ - - ], + "properties": [], "summary": "The [handle](/docs/api/liquid/basics#handles) of the resource associated with the current template.", "name": "handle", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20608,24 +18280,16 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "The `page_description` object can be used to provide a brief description of a page for search engine listings and social\nmedia previews.\n\nTo learn about where to edit the meta description for a page, visit the [Shopify Help Center](https://help.shopify.com/manual/promoting-marketing/seo/adding-keywords#edit-the-title-and-meta-description-for-a-page).", - "properties": [ - - ], + "properties": [], "summary": "The meta description of the current page.", "name": "page_description", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20649,24 +18313,16 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "The resource's featured image for product and collection pages, and blog posts, is used. For all other pages, or pages where\nthere's no featured image, the [social sharing image](https://help.shopify.com/manual/online-store/images/showing-social-media-thumbnail-images?#setting-the-social-sharing-image-in-your-admin)\nis used.\n\n### Open Graph fallback tags\n\nThe `page_image` object can be used for creating [Open Graph](https://ogp.me/) `og:image` meta tags.\n\nIf a theme doesn't include `og:image` tags for a page, then Shopify automatically generates the following tags using the\n`page_image` object:\n\n- `og:image`\n- `og:image:secure_url`\n- `og:image:width`\n- `og:image:height`", - "properties": [ - - ], + "properties": [], "summary": "An image to be shown in search engine listings and social media previews for the current page.", "name": "page_image", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20684,24 +18340,16 @@ { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "The `page_title` object can be used to specify the title of page for search engine listings and social media previews.\n\nTo learn about where to edit the title for a page, visit the [Shopify Help Center](https://help.shopify.com/manual/promoting-marketing/seo/adding-keywords#edit-the-title-and-meta-description-for-a-page).", - "properties": [ - - ], + "properties": [], "summary": "The page title of the current page.", "name": "page_title", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", @@ -20739,9 +18387,7 @@ "property": "previous" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -20751,9 +18397,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "boolean", @@ -20769,9 +18413,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20787,9 +18429,7 @@ "deprecated": false, "deprecation_reason": "", "description": "It consists of the current page URL path with the pagination parameter for the current part appended.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20821,9 +18461,7 @@ "handle": "", "data_from_file": "{\"is_link\":true,\"title\":\"2\",\"url\":\"/collections/all?page=2\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -20834,9 +18472,7 @@ "property": "buyer_pending_payment_instructions" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -20846,9 +18482,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20864,9 +18498,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -20881,34 +18513,24 @@ ], "summary": "Header-value pairs that make up the list of payment information specific to the payment method.\nThis information can be be used by the customer to complete the transaction offline.", "name": "pending_payment_instruction_input", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", "description": "", - "properties": [ - - ], + "properties": [], "summary": "Creates an HTML link element that links to a localized version of `shopify.com`, based on the locale of the store.", "name": "powered_by_link", "examples": [ @@ -20928,9 +18550,7 @@ "handle": "", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -20941,9 +18561,7 @@ "property": "resources" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -20953,9 +18571,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -20971,9 +18587,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -20989,9 +18603,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -21007,9 +18619,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "array", @@ -21024,17 +18634,13 @@ ], "summary": "Contains arrays of objects for each resource type that can be returned by a [predictive search query](/api/ajax/reference/predictive-search#get-locale-search-suggest).", "name": "predictive_search_resources", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"articles\":[],\"collections\":[],\"pages\":[],\"products\":[]}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -21045,9 +18651,7 @@ "property": "quantity_rule" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -21057,9 +18661,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -21075,9 +18677,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If there is no maximum quantity, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -21093,9 +18693,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "number", @@ -21127,19 +18725,13 @@ "handle": "", "data_from_file": "{\"min\":5,\"max\":100,\"increment\":5}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { "global": true, - "parents": [ - - ], - "template": [ - - ] + "parents": [], + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -21175,17 +18767,13 @@ ], "summary": "The active scripts, of each script type, on the store.\n> Caution:\n> Shopify Scripts will be sunset on August 28, 2025. Migrate your existing scripts to [Shopify Functions](/docs/api/functions) before this date.", "name": "scripts", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "scripts", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -21196,9 +18784,7 @@ "property": "sitemap" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -21208,9 +18794,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21226,9 +18810,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21243,17 +18825,13 @@ ], "summary": "The sitemap for a specific group in the [`robots.txt` file](/themes/architecture/templates/robots-txt-liquid).", "name": "sitemap", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/robots.txt", "handle": "robots.default_groups[0].sitemap", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -21268,9 +18846,7 @@ "property": "sort_options" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -21280,9 +18856,7 @@ "deprecated": false, "deprecation_reason": "", "description": "The name can be edited by merchants in the [language editor](https://help.shopify.com/manual/online-store/themes/customizing-themes/language/change-wording).", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21298,9 +18872,7 @@ "deprecated": false, "deprecation_reason": "", "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": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21315,17 +18887,13 @@ ], "summary": "A sort option for a collection or search results page.", "name": "sort_option", - "examples": [ - - ], + "examples": [], "json_data": { "path": "", "handle": "", "data_from_file": "{\"name\":\"Alphabetically, A-Z\",\"value\":\"title-ascending\"}" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -21336,9 +18904,7 @@ "property": "payment_details" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -21348,9 +18914,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21366,9 +18930,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21384,9 +18946,7 @@ "deprecated": false, "deprecation_reason": "", "description": "All but the last four digits are redacted.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21402,9 +18962,7 @@ "deprecated": false, "deprecation_reason": "", "description": "If no gift card was used, then `nil` is returned.", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "gift_card", @@ -21419,17 +18977,13 @@ ], "summary": "Information about the payment methods used for a transaction.", "name": "transaction_payment_details", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/", "handle": "customer.orders[4].transactions[0].payment_details", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] }, { "access": { @@ -21440,9 +18994,7 @@ "property": "user_agent" } ], - "template": [ - - ] + "template": [] }, "deprecated": false, "deprecation_reason": "", @@ -21452,9 +19004,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21470,9 +19020,7 @@ "deprecated": false, "deprecation_reason": "", "description": "", - "examples": [ - - ], + "examples": [], "return_type": [ { "type": "string", @@ -21487,16 +19035,12 @@ ], "summary": "The user-agent, which is the name of the crawler, for a specific group in the [`robots.txt` file](/themes/architecture/templates/robots-txt-liquid).", "name": "user_agent", - "examples": [ - - ], + "examples": [], "json_data": { "path": "/robots.txt", "handle": "robots.default_groups[0].user_agent", "data_from_file": "" }, - "return_type": [ - - ] + "return_type": [] } ] \ No newline at end of file