theme-check 1.13.0 → 1.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/data/shopify_liquid/documentation/filters.json +90 -60
- data/data/shopify_liquid/documentation/objects.json +996 -348
- data/data/shopify_liquid/documentation/tags.json +81 -30
- data/docs/checks/img_lazy_loading.md +7 -5
- data/docs/checks/schema_json_format.md +3 -3
- data/lib/theme_check/checks/img_lazy_loading.rb +1 -5
- data/lib/theme_check/cli.rb +15 -0
- data/lib/theme_check/language_server/completion_providers/filter_completion_provider.rb +15 -9
- data/lib/theme_check/shopify_liquid/documentation/markdown_template.rb +1 -1
- data/lib/theme_check/shopify_liquid/source_index/base_entry.rb +7 -1
- data/lib/theme_check/shopify_liquid/source_index/filter_entry.rb +5 -1
- data/lib/theme_check/shopify_liquid/source_index/object_entry.rb +7 -1
- data/lib/theme_check/shopify_liquid/source_index/parameter_entry.rb +4 -0
- data/lib/theme_check/shopify_liquid/source_index/property_entry.rb +13 -1
- data/lib/theme_check/shopify_liquid/source_index/return_type_entry.rb +4 -0
- data/lib/theme_check/shopify_liquid/source_index/tag_entry.rb +4 -0
- data/lib/theme_check/version.rb +1 -1
- metadata +3 -3
@@ -22,7 +22,7 @@
|
|
22
22
|
},
|
23
23
|
"deprecated": false,
|
24
24
|
"deprecation_reason": "",
|
25
|
-
"description": "The `media` object can be returned by the [`product.media` array](/api/liquid/objects/product#product-media) or a\n[`file_reference` metafield](/apps/metafields/types).\n\nYou can use [media filters](/api/liquid/filters/media-filters) to generate URLs and media displays. To learn about how\nto use media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).\n\n> Note:\n> Each media type has unique properties in addition to the general `media` properties. To learn about these\n> additional properties, refer to the reference for each type.",
|
25
|
+
"description": "The `media` object can be returned by the [`product.media` array](/docs/api/liquid/objects/product#product-media) or a\n[`file_reference` metafield](/apps/metafields/types).\n\nYou can use [media filters](/docs/api/liquid/filters/media-filters) to generate URLs and media displays. To learn about how\nto use media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).\n\n> Note:\n> Each media type has unique properties in addition to the general `media` properties. To learn about these\n> additional properties, refer to the reference for each type.",
|
26
26
|
"properties": [
|
27
27
|
{
|
28
28
|
"deprecated": false,
|
@@ -57,7 +57,7 @@
|
|
57
57
|
"array_value": ""
|
58
58
|
}
|
59
59
|
],
|
60
|
-
"summary": "The position of the media in the [`product.media` array](/api/liquid/objects/product#product-media).",
|
60
|
+
"summary": "The position of the media in the [`product.media` array](/docs/api/liquid/objects/product#product-media).",
|
61
61
|
"name": "position"
|
62
62
|
},
|
63
63
|
{
|
@@ -67,7 +67,7 @@
|
|
67
67
|
"examples": [
|
68
68
|
{
|
69
69
|
"name": "Filter for media of a specific type",
|
70
|
-
"description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
70
|
+
"description": "You can use the `media_type` property with the [`where` filter](/docs/api/liquid/filters/where) to filter the [`product.media` array](/docs/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
71
71
|
"syntax": "",
|
72
72
|
"path": "/products/snake-venom",
|
73
73
|
"raw_liquid": "{% assign images = product.media | where: 'media_type', 'image' %}\n\n{% for image in images %}\n {{- image | image_url: width: 300 | image_tag }}\n{% endfor %}",
|
@@ -142,7 +142,7 @@
|
|
142
142
|
"name": "alt"
|
143
143
|
}
|
144
144
|
],
|
145
|
-
"summary": "An abstract media object that can represent the following object types:\n\n- [`image`](/api/liquid/objects/image)\n- [`model`](/api/liquid/objects/model)\n- [`video`](/api/liquid/objects/video)\n- [`external_video`](/api/liquid/objects/external_video)",
|
145
|
+
"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)",
|
146
146
|
"name": "media",
|
147
147
|
"examples": [
|
148
148
|
|
@@ -199,7 +199,7 @@
|
|
199
199
|
},
|
200
200
|
"deprecated": false,
|
201
201
|
"deprecation_reason": "",
|
202
|
-
"description": "> Tip:\n> Use the [`format_address` filter](/api/liquid/filters/format_address) to output an address according to its locale.",
|
202
|
+
"description": "> Tip:\n> Use the [`format_address` filter](/docs/api/liquid/filters/format_address) to output an address according to its locale.",
|
203
203
|
"properties": [
|
204
204
|
{
|
205
205
|
"deprecated": false,
|
@@ -538,7 +538,7 @@
|
|
538
538
|
"properties": [
|
539
539
|
|
540
540
|
],
|
541
|
-
"summary": "All of the [collections](/api/liquid/objects/collection) on a store.",
|
541
|
+
"summary": "All of the [collections](/docs/api/liquid/objects/collection) on a store.",
|
542
542
|
"name": "collections",
|
543
543
|
"examples": [
|
544
544
|
{
|
@@ -553,7 +553,7 @@
|
|
553
553
|
},
|
554
554
|
{
|
555
555
|
"name": "Access a specific collection",
|
556
|
-
"description": "You can use `collections` to access a collection by its [handle](/api/liquid/basics#handles).\n",
|
556
|
+
"description": "You can use `collections` to access a collection by its [handle](/docs/api/liquid/basics#handles).\n",
|
557
557
|
"syntax": "",
|
558
558
|
"path": "/",
|
559
559
|
"raw_liquid": "{% for product in collections['sale-potions'].products %}\n {{- product.title | link_to: product.url }}\n{% endfor %}",
|
@@ -592,12 +592,12 @@
|
|
592
592
|
"properties": [
|
593
593
|
|
594
594
|
],
|
595
|
-
"summary": "All of the [pages](/api/liquid/objects/page) on a store.",
|
595
|
+
"summary": "All of the [pages](/docs/api/liquid/objects/page) on a store.",
|
596
596
|
"name": "pages",
|
597
597
|
"examples": [
|
598
598
|
{
|
599
599
|
"name": "",
|
600
|
-
"description": "You can access a specific page through the `pages` object using the page's [handle](/api/liquid/basics#handles).\n",
|
600
|
+
"description": "You can access a specific page through the `pages` object using the page's [handle](/docs/api/liquid/basics#handles).\n",
|
601
601
|
"syntax": "",
|
602
602
|
"path": "/",
|
603
603
|
"raw_liquid": "{{ pages.contact.title }}\n{{ pages['about-us'].title }}",
|
@@ -607,7 +607,7 @@
|
|
607
607
|
},
|
608
608
|
{
|
609
609
|
"name": "Paginate the `pages` object",
|
610
|
-
"description": "You can [paginate](/api/liquid/tags/paginate) the `pages` object, allowing you to iterate over up to 50 pages at a time.\n",
|
610
|
+
"description": "You can [paginate](/docs/api/liquid/tags/paginate) the `pages` object, allowing you to iterate over up to 50 pages at a time.\n",
|
611
611
|
"syntax": "",
|
612
612
|
"path": "/",
|
613
613
|
"raw_liquid": "{% paginate pages by 2 -%}\n {% for page in pages -%}\n {{ page.title | link_to: page.url }}\n {%- endfor %}\n\n {{- paginate | default_pagination }}\n{%- endpaginate %}",
|
@@ -651,7 +651,7 @@
|
|
651
651
|
"examples": [
|
652
652
|
{
|
653
653
|
"name": "",
|
654
|
-
"description": "You can use `all_products` to access a product by its [handle](/api/liquid/basics#handles). If the product isn't found, then `nil` is returned.",
|
654
|
+
"description": "You can use `all_products` to access a product by its [handle](/docs/api/liquid/basics#handles). If the product isn't found, then `nil` is returned.",
|
655
655
|
"syntax": "",
|
656
656
|
"path": "/",
|
657
657
|
"raw_liquid": "{{ all_products['love-potion'].title }}",
|
@@ -698,7 +698,7 @@
|
|
698
698
|
"return_type": [
|
699
699
|
|
700
700
|
],
|
701
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) that are [owned by the app](/apps/metafields/app-owned).",
|
701
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) that are [owned by the app](/apps/metafields/app-owned).",
|
702
702
|
"name": "metafields"
|
703
703
|
}
|
704
704
|
],
|
@@ -742,13 +742,13 @@
|
|
742
742
|
]
|
743
743
|
},
|
744
744
|
"deprecated": true,
|
745
|
-
"deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `discount` object has been replaced by the [`discount_allocation`](/api/liquid/objects/discount_allocation) and\n[`discount_application`](/api/liquid/objects/discount_application) objects.",
|
745
|
+
"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.",
|
746
746
|
"description": "",
|
747
747
|
"properties": [
|
748
748
|
{
|
749
749
|
"deprecated": false,
|
750
750
|
"deprecation_reason": "",
|
751
|
-
"description": "> Note:\n> This is the same value as [`discount.total_amount`](/api/liquid/objects/discount#discount-total_amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
751
|
+
"description": "> Note:\n> This is the same value as [`discount.total_amount`](/docs/api/liquid/objects/discount#discount-total_amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
752
752
|
"examples": [
|
753
753
|
|
754
754
|
],
|
@@ -766,7 +766,7 @@
|
|
766
766
|
{
|
767
767
|
"deprecated": false,
|
768
768
|
"deprecation_reason": "",
|
769
|
-
"description": "> Note:\n> This is the same value as [`discount.amount`](/api/liquid/objects/discount#discount-amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
769
|
+
"description": "> Note:\n> This is the same value as [`discount.amount`](/docs/api/liquid/objects/discount#discount-amount).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
770
770
|
"examples": [
|
771
771
|
|
772
772
|
],
|
@@ -784,7 +784,7 @@
|
|
784
784
|
{
|
785
785
|
"deprecated": false,
|
786
786
|
"deprecation_reason": "",
|
787
|
-
"description": "> Note:\n> This is the same value as [`discount.title`](/api/liquid/objects/discount#discount-title).",
|
787
|
+
"description": "> Note:\n> This is the same value as [`discount.title`](/docs/api/liquid/objects/discount#discount-title).",
|
788
788
|
"examples": [
|
789
789
|
|
790
790
|
],
|
@@ -802,7 +802,7 @@
|
|
802
802
|
{
|
803
803
|
"deprecated": false,
|
804
804
|
"deprecation_reason": "",
|
805
|
-
"description": "> Note:\n> This is the same value as [`discount.code`](/api/liquid/objects/discount#discount-code).",
|
805
|
+
"description": "> Note:\n> This is the same value as [`discount.code`](/docs/api/liquid/objects/discount#discount-code).",
|
806
806
|
"examples": [
|
807
807
|
|
808
808
|
],
|
@@ -850,7 +850,7 @@
|
|
850
850
|
{
|
851
851
|
"deprecated": false,
|
852
852
|
"deprecation_reason": "",
|
853
|
-
"description": "> Note:\n> This is the same value as [`discount.total_savings`](/api/liquid/objects/discount#discount-total_savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
853
|
+
"description": "> Note:\n> This is the same value as [`discount.total_savings`](/docs/api/liquid/objects/discount#discount-total_savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
854
854
|
"examples": [
|
855
855
|
|
856
856
|
],
|
@@ -868,7 +868,7 @@
|
|
868
868
|
{
|
869
869
|
"deprecated": false,
|
870
870
|
"deprecation_reason": "",
|
871
|
-
"description": "> Note:\n> This is the same value as [`discount.savings`](/api/liquid/objects/discount#discount-savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
871
|
+
"description": "> Note:\n> This is the same value as [`discount.savings`](/docs/api/liquid/objects/discount#discount-savings).\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
872
872
|
"examples": [
|
873
873
|
|
874
874
|
],
|
@@ -919,7 +919,7 @@
|
|
919
919
|
"examples": [
|
920
920
|
{
|
921
921
|
"name": "",
|
922
|
-
"description": "You can use `articles` to access an article by its [handle](/api/liquid/basics#handles).\n",
|
922
|
+
"description": "You can use `articles` to access an article by its [handle](/docs/api/liquid/basics#handles).\n",
|
923
923
|
"syntax": "",
|
924
924
|
"path": "/",
|
925
925
|
"raw_liquid": "{% assign article = articles['potion-notions/new-potions-for-spring'] %}\n{{ article.title | link_to: article.url }}",
|
@@ -1014,7 +1014,7 @@
|
|
1014
1014
|
"array_value": ""
|
1015
1015
|
}
|
1016
1016
|
],
|
1017
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the article.",
|
1017
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the article.",
|
1018
1018
|
"name": "metafields"
|
1019
1019
|
},
|
1020
1020
|
{
|
@@ -1032,7 +1032,7 @@
|
|
1032
1032
|
"array_value": ""
|
1033
1033
|
}
|
1034
1034
|
],
|
1035
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the article.",
|
1035
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the article.",
|
1036
1036
|
"name": "handle"
|
1037
1037
|
},
|
1038
1038
|
{
|
@@ -1110,7 +1110,7 @@
|
|
1110
1110
|
{
|
1111
1111
|
"deprecated": false,
|
1112
1112
|
"deprecation_reason": "",
|
1113
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
1113
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
1114
1114
|
"examples": [
|
1115
1115
|
|
1116
1116
|
],
|
@@ -1128,7 +1128,7 @@
|
|
1128
1128
|
{
|
1129
1129
|
"deprecated": false,
|
1130
1130
|
"deprecation_reason": "",
|
1131
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
1131
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
1132
1132
|
"examples": [
|
1133
1133
|
|
1134
1134
|
],
|
@@ -1146,7 +1146,7 @@
|
|
1146
1146
|
{
|
1147
1147
|
"deprecated": false,
|
1148
1148
|
"deprecation_reason": "",
|
1149
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
1149
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
1150
1150
|
"examples": [
|
1151
1151
|
|
1152
1152
|
],
|
@@ -1182,7 +1182,7 @@
|
|
1182
1182
|
{
|
1183
1183
|
"deprecated": false,
|
1184
1184
|
"deprecation_reason": "",
|
1185
|
-
"description": "Returns an empty array if comments are disabled.\n\n> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many comments to show at once, up to a limit of 50.",
|
1185
|
+
"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.",
|
1186
1186
|
"examples": [
|
1187
1187
|
|
1188
1188
|
],
|
@@ -1302,7 +1302,7 @@
|
|
1302
1302
|
"array_value": ""
|
1303
1303
|
}
|
1304
1304
|
],
|
1305
|
-
"summary": "Returns the article [excerpt](/api/liquid/objects/article#article-excerpt) if it exists. Returns the article\n[content](/api/liquid/objects/article#article-content) if no excerpt exists.",
|
1305
|
+
"summary": "Returns the article [excerpt](/docs/api/liquid/objects/article#article-excerpt) if it exists. Returns the article\n[content](/docs/api/liquid/objects/article#article-content) if no excerpt exists.",
|
1306
1306
|
"name": "excerpt_or_content"
|
1307
1307
|
},
|
1308
1308
|
{
|
@@ -1490,7 +1490,7 @@
|
|
1490
1490
|
"examples": [
|
1491
1491
|
{
|
1492
1492
|
"name": "",
|
1493
|
-
"description": "You can use `blogs` to access a blog by its [handle](/api/liquid/basics#handles).\n",
|
1493
|
+
"description": "You can use `blogs` to access a blog by its [handle](/docs/api/liquid/basics#handles).\n",
|
1494
1494
|
"syntax": "",
|
1495
1495
|
"path": "/",
|
1496
1496
|
"raw_liquid": "{% for article in blogs.potion-notions.articles %}\n {{- article.title | link_to: article.url }}\n{% endfor %}",
|
@@ -1579,13 +1579,13 @@
|
|
1579
1579
|
"array_value": ""
|
1580
1580
|
}
|
1581
1581
|
],
|
1582
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the blog.",
|
1582
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the blog.",
|
1583
1583
|
"name": "handle"
|
1584
1584
|
},
|
1585
1585
|
{
|
1586
1586
|
"deprecated": false,
|
1587
1587
|
"deprecation_reason": "",
|
1588
|
-
"description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many articles to show per page, up to a limit of 50.",
|
1588
|
+
"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.",
|
1589
1589
|
"examples": [
|
1590
1590
|
|
1591
1591
|
],
|
@@ -1633,7 +1633,7 @@
|
|
1633
1633
|
"array_value": "metafield"
|
1634
1634
|
}
|
1635
1635
|
],
|
1636
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the blog.",
|
1636
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the blog.",
|
1637
1637
|
"name": "metafields"
|
1638
1638
|
},
|
1639
1639
|
{
|
@@ -1705,7 +1705,7 @@
|
|
1705
1705
|
"array_value": "string"
|
1706
1706
|
}
|
1707
1707
|
],
|
1708
|
-
"summary": "A list of all of the tags on all of the articles in the blog.\n\nUnlike [`blog.all_tags`](/api/liquid/objects/blog#blog-all_tags), this property only returns tags of articles that are in the\nfiltered view.",
|
1708
|
+
"summary": "A list of all of the tags on all of the articles in the blog.\n\nUnlike [`blog.all_tags`](/docs/api/liquid/objects/blog#blog-all_tags), this property only returns tags of articles that are in the\nfiltered view.",
|
1709
1709
|
"name": "tags"
|
1710
1710
|
},
|
1711
1711
|
{
|
@@ -1875,7 +1875,7 @@
|
|
1875
1875
|
{
|
1876
1876
|
"deprecated": false,
|
1877
1877
|
"deprecation_reason": "",
|
1878
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
1878
|
+
"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.",
|
1879
1879
|
"examples": [
|
1880
1880
|
|
1881
1881
|
],
|
@@ -1893,7 +1893,7 @@
|
|
1893
1893
|
{
|
1894
1894
|
"deprecated": false,
|
1895
1895
|
"deprecation_reason": "",
|
1896
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
1896
|
+
"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.",
|
1897
1897
|
"examples": [
|
1898
1898
|
|
1899
1899
|
],
|
@@ -1911,7 +1911,7 @@
|
|
1911
1911
|
{
|
1912
1912
|
"deprecated": false,
|
1913
1913
|
"deprecation_reason": "",
|
1914
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
1914
|
+
"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.",
|
1915
1915
|
"examples": [
|
1916
1916
|
|
1917
1917
|
],
|
@@ -1929,7 +1929,7 @@
|
|
1929
1929
|
{
|
1930
1930
|
"deprecated": false,
|
1931
1931
|
"deprecation_reason": "",
|
1932
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
1932
|
+
"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.",
|
1933
1933
|
"examples": [
|
1934
1934
|
|
1935
1935
|
],
|
@@ -1947,7 +1947,7 @@
|
|
1947
1947
|
{
|
1948
1948
|
"deprecated": false,
|
1949
1949
|
"deprecation_reason": "",
|
1950
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
1950
|
+
"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.",
|
1951
1951
|
"examples": [
|
1952
1952
|
|
1953
1953
|
],
|
@@ -2001,7 +2001,7 @@
|
|
2001
2001
|
{
|
2002
2002
|
"deprecated": false,
|
2003
2003
|
"deprecation_reason": "",
|
2004
|
-
"description": "If the store uses multi-currency, then this is the same as the customer's local\n(presentment) currency. Otherwise, it's the same as the store currency.\n\n> Tip:\n> You can output the store's available currencies using [`shop.enabled_currencies`](/api/liquid/objects/shop#shop-enabled_currencies).",
|
2004
|
+
"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).",
|
2005
2005
|
"examples": [
|
2006
2006
|
|
2007
2007
|
],
|
@@ -2014,7 +2014,7 @@
|
|
2014
2014
|
{
|
2015
2015
|
"deprecated": false,
|
2016
2016
|
"deprecation_reason": "",
|
2017
|
-
"description": "",
|
2017
|
+
"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.",
|
2018
2018
|
"examples": [
|
2019
2019
|
|
2020
2020
|
],
|
@@ -2026,7 +2026,7 @@
|
|
2026
2026
|
"array_value": ""
|
2027
2027
|
}
|
2028
2028
|
],
|
2029
|
-
"summary": "The total weight of all of the items in the cart.",
|
2029
|
+
"summary": "The total weight of all of the items in the cart in grams.",
|
2030
2030
|
"name": "total_weight"
|
2031
2031
|
},
|
2032
2032
|
{
|
@@ -2112,7 +2112,7 @@
|
|
2112
2112
|
},
|
2113
2113
|
{
|
2114
2114
|
"deprecated": true,
|
2115
|
-
"deprecation_reason": "Deprecated because not all discount types and details are available.\n\nThe `cart.discounts` property has been replaced by [`cart.discount_applications`](/api/liquid/objects/cart#cart-discount_applications).",
|
2115
|
+
"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).",
|
2116
2116
|
"description": "",
|
2117
2117
|
"examples": [
|
2118
2118
|
|
@@ -2193,7 +2193,7 @@
|
|
2193
2193
|
"array_value": "metafield"
|
2194
2194
|
}
|
2195
2195
|
],
|
2196
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the collection.",
|
2196
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the collection.",
|
2197
2197
|
"name": "metafields"
|
2198
2198
|
},
|
2199
2199
|
{
|
@@ -2229,7 +2229,7 @@
|
|
2229
2229
|
"array_value": ""
|
2230
2230
|
}
|
2231
2231
|
],
|
2232
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the collection.",
|
2232
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the collection.",
|
2233
2233
|
"name": "handle"
|
2234
2234
|
},
|
2235
2235
|
{
|
@@ -2343,7 +2343,7 @@
|
|
2343
2343
|
{
|
2344
2344
|
"deprecated": false,
|
2345
2345
|
"deprecation_reason": "",
|
2346
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
2346
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
2347
2347
|
"examples": [
|
2348
2348
|
|
2349
2349
|
],
|
@@ -2532,7 +2532,7 @@
|
|
2532
2532
|
{
|
2533
2533
|
"deprecated": false,
|
2534
2534
|
"deprecation_reason": "",
|
2535
|
-
"description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many products to show per page, up to a limit of 50.",
|
2535
|
+
"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.",
|
2536
2536
|
"examples": [
|
2537
2537
|
|
2538
2538
|
],
|
@@ -2550,7 +2550,7 @@
|
|
2550
2550
|
{
|
2551
2551
|
"deprecated": false,
|
2552
2552
|
"deprecation_reason": "",
|
2553
|
-
"description": "This includes products that have been filtered out of the current view.\n\n> Tip:\n> To display the number of products in a filtered collection, use [`collection.products_count`](/api/liquid/objects/collection#collection-products_count).",
|
2553
|
+
"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).",
|
2554
2554
|
"examples": [
|
2555
2555
|
|
2556
2556
|
],
|
@@ -2568,7 +2568,7 @@
|
|
2568
2568
|
{
|
2569
2569
|
"deprecated": false,
|
2570
2570
|
"deprecation_reason": "",
|
2571
|
-
"description": "This includes tags for products that have been filtered out of the current view.\nA maximum of 1,000 tags can be returned.\n\n> Tip:\n> To display the tags that are currently applied, use [`collection.tags`](/api/liquid/objects/collection#collection-tags).",
|
2571
|
+
"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).",
|
2572
2572
|
"examples": [
|
2573
2573
|
|
2574
2574
|
],
|
@@ -2608,7 +2608,7 @@
|
|
2608
2608
|
"examples": [
|
2609
2609
|
{
|
2610
2610
|
"name": "Create links to product types",
|
2611
|
-
"description": "Use the [`link_to_type`](/api/liquid/filters/link_to_type) filter to create links to the product types in a collection.\n",
|
2611
|
+
"description": "Use the [`link_to_type`](/docs/api/liquid/filters/link_to_type) filter to create links to the product types in a collection.\n",
|
2612
2612
|
"syntax": "",
|
2613
2613
|
"path": "/collections/ingredients",
|
2614
2614
|
"raw_liquid": "{% for product_type in collection.all_types -%}\n {{- product_type | link_to_type }}\n{%- endfor %}",
|
@@ -2635,7 +2635,7 @@
|
|
2635
2635
|
"examples": [
|
2636
2636
|
{
|
2637
2637
|
"name": "Create links to vendors",
|
2638
|
-
"description": "Use the [`link_to_vendor`](/api/liquid/filters/link_to_vendor) filter to create links to the vendors in a collection.\n",
|
2638
|
+
"description": "Use the [`link_to_vendor`](/docs/api/liquid/filters/link_to_vendor) filter to create links to the vendors in a collection.\n",
|
2639
2639
|
"syntax": "",
|
2640
2640
|
"path": "/collections/ingredients",
|
2641
2641
|
"raw_liquid": "{% for product_vendor in collection.all_vendors %}\n {{- product_vendor | link_to_vendor }}\n{% endfor %}",
|
@@ -2676,7 +2676,7 @@
|
|
2676
2676
|
{
|
2677
2677
|
"deprecated": false,
|
2678
2678
|
"deprecation_reason": "",
|
2679
|
-
"description": "The default is the [collection image](/api/liquid/objects/collection#collection-image). If this image isn't available, then\nShopify falls back to the featured image of the first product in the collection. If the first product in the collection\ndoesn't have a featured image, then `nil` is returned.",
|
2679
|
+
"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.",
|
2680
2680
|
"examples": [
|
2681
2681
|
|
2682
2682
|
],
|
@@ -2718,7 +2718,7 @@
|
|
2718
2718
|
},
|
2719
2719
|
"deprecated": false,
|
2720
2720
|
"deprecation_reason": "",
|
2721
|
-
"description": "> Tip:\n> Use [color filters](/api/liquid/filters/color-filters) to modify or extract properties of a `color` object.",
|
2721
|
+
"description": "> Tip:\n> Use [color filters](/docs/api/liquid/filters/color-filters) to modify or extract properties of a `color` object.",
|
2722
2722
|
"properties": [
|
2723
2723
|
{
|
2724
2724
|
"deprecated": false,
|
@@ -2923,6 +2923,24 @@
|
|
2923
2923
|
"deprecation_reason": "",
|
2924
2924
|
"description": "To learn about B2B in themes, refer to [Support B2B customers in your theme](/themes/pricing-payments/b2b).",
|
2925
2925
|
"properties": [
|
2926
|
+
{
|
2927
|
+
"deprecated": false,
|
2928
|
+
"deprecation_reason": "",
|
2929
|
+
"description": "",
|
2930
|
+
"examples": [
|
2931
|
+
|
2932
|
+
],
|
2933
|
+
"return_type": [
|
2934
|
+
{
|
2935
|
+
"type": "string",
|
2936
|
+
"name": "",
|
2937
|
+
"description": "",
|
2938
|
+
"array_value": ""
|
2939
|
+
}
|
2940
|
+
],
|
2941
|
+
"summary": "The attention line of the address.",
|
2942
|
+
"name": "attention"
|
2943
|
+
},
|
2926
2944
|
{
|
2927
2945
|
"deprecated": false,
|
2928
2946
|
"deprecation_reason": "",
|
@@ -3194,7 +3212,7 @@
|
|
3194
3212
|
"name": "available_locations"
|
3195
3213
|
}
|
3196
3214
|
],
|
3197
|
-
"summary": "A company that a [customer](/api/liquid/objects/customer) is purchasing for.",
|
3215
|
+
"summary": "A company that a [customer](/docs/api/liquid/objects/customer) is purchasing for.",
|
3198
3216
|
"name": "company",
|
3199
3217
|
"examples": [
|
3200
3218
|
|
@@ -3360,7 +3378,7 @@
|
|
3360
3378
|
"name": "tax_registration_id"
|
3361
3379
|
}
|
3362
3380
|
],
|
3363
|
-
"summary": "A location of the [company](/api/liquid/objects/company) that a [customer](/api/liquid/objects/customer) is purchasing for.",
|
3381
|
+
"summary": "A location of the [company](/docs/api/liquid/objects/company) that a [customer](/docs/api/liquid/objects/customer) is purchasing for.",
|
3364
3382
|
"name": "company_location",
|
3365
3383
|
"examples": [
|
3366
3384
|
|
@@ -3510,6 +3528,24 @@
|
|
3510
3528
|
],
|
3511
3529
|
"summary": "The currency used in the country.",
|
3512
3530
|
"name": "currency"
|
3531
|
+
},
|
3532
|
+
{
|
3533
|
+
"deprecated": false,
|
3534
|
+
"deprecation_reason": "",
|
3535
|
+
"description": "",
|
3536
|
+
"examples": [
|
3537
|
+
|
3538
|
+
],
|
3539
|
+
"return_type": [
|
3540
|
+
{
|
3541
|
+
"type": "market",
|
3542
|
+
"name": "",
|
3543
|
+
"description": "",
|
3544
|
+
"array_value": ""
|
3545
|
+
}
|
3546
|
+
],
|
3547
|
+
"summary": "The market that includes this country.",
|
3548
|
+
"name": "market"
|
3513
3549
|
}
|
3514
3550
|
],
|
3515
3551
|
"summary": "A country supported by the store's localization options.",
|
@@ -3524,6 +3560,16 @@
|
|
3524
3560
|
"parameter": false,
|
3525
3561
|
"display_type": "text",
|
3526
3562
|
"show_data_tab": true
|
3563
|
+
},
|
3564
|
+
{
|
3565
|
+
"name": "Rendering a flag image",
|
3566
|
+
"description": "When the country object is passed to the [`image_url`](/docs/api/liquid/filters#image_url) filter, a [CDN URL](/themes/best-practices/performance/platform#shopify-cdn) for that country’s flag is returned. All country’s flags are SVGs, normalized to an aspect ratio of 4:3.\n",
|
3567
|
+
"syntax": "",
|
3568
|
+
"path": "/",
|
3569
|
+
"raw_liquid": "{{ localization.country | image_url: width: 32 | image_tag }}",
|
3570
|
+
"parameter": false,
|
3571
|
+
"display_type": "text",
|
3572
|
+
"show_data_tab": true
|
3527
3573
|
}
|
3528
3574
|
],
|
3529
3575
|
"json_data": {
|
@@ -3670,7 +3716,7 @@
|
|
3670
3716
|
},
|
3671
3717
|
"deprecated": false,
|
3672
3718
|
"deprecation_reason": "",
|
3673
|
-
"description": "The `customer` object is directly accessible globally when a customer is logged in to their account. It's also defined in\nthe following contexts:\n\n- The [`customers/account` template](/themes/architecture/templates/customers-account)\n- The [`customers/addresses` template](/themes/architecture/templates/customers-addresses)\n- The [`customers/order` template](/themes/architecture/templates/customers-order)\n- When accessing [`checkout.customer`](/api/liquid/objects/checkout#checkout-customer)\n- When accessing [`gift_card.customer`](/api/liquid/objects/gift_card#gift_card-customer)\n- When accessing [`order.customer`](/api/liquid/objects/order#order-customer)\n\nOutside of the above contexts, if the customer isn't logged into their account, the `customer` object returns `nil`.",
|
3719
|
+
"description": "The `customer` object is directly accessible globally when a customer is logged in to their account. It's also defined in\nthe following contexts:\n\n- The [`customers/account` template](/themes/architecture/templates/customers-account)\n- The [`customers/addresses` template](/themes/architecture/templates/customers-addresses)\n- The [`customers/order` template](/themes/architecture/templates/customers-order)\n- When accessing [`checkout.customer`](/docs/api/liquid/objects/checkout#checkout-customer)\n- When accessing [`gift_card.customer`](/docs/api/liquid/objects/gift_card#gift_card-customer)\n- When accessing [`order.customer`](/docs/api/liquid/objects/order#order-customer)\n\nOutside of the above contexts, if the customer isn't logged into their account, the `customer` object returns `nil`.",
|
3674
3720
|
"properties": [
|
3675
3721
|
{
|
3676
3722
|
"deprecated": false,
|
@@ -3729,7 +3775,7 @@
|
|
3729
3775
|
{
|
3730
3776
|
"deprecated": false,
|
3731
3777
|
"deprecation_reason": "",
|
3732
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
3778
|
+
"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.",
|
3733
3779
|
"examples": [
|
3734
3780
|
|
3735
3781
|
],
|
@@ -3747,7 +3793,7 @@
|
|
3747
3793
|
{
|
3748
3794
|
"deprecated": false,
|
3749
3795
|
"deprecation_reason": "",
|
3750
|
-
"description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many orders to show at once, up to a limit of 20.",
|
3796
|
+
"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.",
|
3751
3797
|
"examples": [
|
3752
3798
|
|
3753
3799
|
],
|
@@ -3927,7 +3973,7 @@
|
|
3927
3973
|
{
|
3928
3974
|
"deprecated": false,
|
3929
3975
|
"deprecation_reason": "",
|
3930
|
-
"description": "> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many addresses to show at once, up to a limit of 20.",
|
3976
|
+
"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.",
|
3931
3977
|
"examples": [
|
3932
3978
|
|
3933
3979
|
],
|
@@ -4116,7 +4162,7 @@
|
|
4116
4162
|
{
|
4117
4163
|
"deprecated": false,
|
4118
4164
|
"deprecation_reason": "",
|
4119
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
4165
|
+
"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.",
|
4120
4166
|
"examples": [
|
4121
4167
|
|
4122
4168
|
],
|
@@ -4174,7 +4220,7 @@
|
|
4174
4220
|
{
|
4175
4221
|
"deprecated": false,
|
4176
4222
|
"deprecation_reason": "",
|
4177
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
4223
|
+
"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.",
|
4178
4224
|
"examples": [
|
4179
4225
|
|
4180
4226
|
],
|
@@ -4210,7 +4256,7 @@
|
|
4210
4256
|
{
|
4211
4257
|
"deprecated": false,
|
4212
4258
|
"deprecation_reason": "",
|
4213
|
-
"description": "How this value is interpreted depends on the [value type](/api/liquid/objects/discount_application#discount_application-value_type) of the\ndiscount. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount of the discount in the currency's subunit. |\n| `percentage` | The percent amount of the discount. |\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
4259
|
+
"description": "How this value is interpreted depends on the [value type](/docs/api/liquid/objects/discount_application#discount_application-value_type) of the\ndiscount. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount of the discount in the currency's subunit. |\n| `percentage` | The percent amount of the discount. |\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
4214
4260
|
"examples": [
|
4215
4261
|
|
4216
4262
|
],
|
@@ -4228,7 +4274,7 @@
|
|
4228
4274
|
{
|
4229
4275
|
"deprecated": false,
|
4230
4276
|
"deprecation_reason": "",
|
4231
|
-
"description": "> Note:\n> Whether the selection method applies to line items or shipping lines depends on the discount's\n> [target type](/api/liquid/objects/discount_application#discount_application-target_type).",
|
4277
|
+
"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).",
|
4232
4278
|
"examples": [
|
4233
4279
|
|
4234
4280
|
],
|
@@ -4369,7 +4415,7 @@
|
|
4369
4415
|
},
|
4370
4416
|
"deprecated": false,
|
4371
4417
|
"deprecation_reason": "",
|
4372
|
-
"description": "> Tip:\n> Use the [`external_video_tag` filter](/api/liquid/filters/external_video_tag) to output the video in an\n> HTML `<iframe>` tag. Use the [`external_video_url` filter](/api/liquid/filters/external_video_url) to specify parameters\n> for the external video player.",
|
4418
|
+
"description": "> Tip:\n> Use the [`external_video_tag` filter](/docs/api/liquid/filters/external_video_tag) to output the video in an\n> HTML `<iframe>` tag. Use the [`external_video_url` filter](/docs/api/liquid/filters/external_video_url) to specify parameters\n> for the external video player.",
|
4373
4419
|
"properties": [
|
4374
4420
|
{
|
4375
4421
|
"deprecated": false,
|
@@ -4474,7 +4520,7 @@
|
|
4474
4520
|
"examples": [
|
4475
4521
|
{
|
4476
4522
|
"name": "Filter for media of a specific type",
|
4477
|
-
"description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
4523
|
+
"description": "You can use the `media_type` property with the [`where` filter](/docs/api/liquid/filters/where) to filter the [`product.media` array](/docs/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
4478
4524
|
"syntax": "",
|
4479
4525
|
"path": "/products/potion-beats",
|
4480
4526
|
"raw_liquid": "{% assign external_videos = product.media | where: 'media_type', 'external_video' %}\n\n{% for external_video in external_videos %}\n {{- external_video | external_video_tag }}\n{% endfor %}",
|
@@ -4509,7 +4555,7 @@
|
|
4509
4555
|
"array_value": ""
|
4510
4556
|
}
|
4511
4557
|
],
|
4512
|
-
"summary": "The position of the external video in the [`product.media`](/api/liquid/objects/product#product-media) array.",
|
4558
|
+
"summary": "The position of the external video in the [`product.media`](/docs/api/liquid/objects/product#product-media) array.",
|
4513
4559
|
"name": "position"
|
4514
4560
|
},
|
4515
4561
|
{
|
@@ -4998,7 +5044,7 @@
|
|
4998
5044
|
},
|
4999
5045
|
"deprecated": false,
|
5000
5046
|
"deprecation_reason": "",
|
5001
|
-
"description": "The focal point will remain visible when the image is cropped by the\ntheme. [Learn more about supporting focal points in your theme](https://shopify.dev/themes/architecture/settings/input-settings#image-focal-points).\n\n> Tip:\n> Use the [`image_tag`](/api/liquid/filters/image_tag) filter to automatically apply focal point settings to an\n> image on the storefront. This applies the focal point using the `object-position` CSS property.",
|
5047
|
+
"description": "The focal point will remain visible when the image is cropped by the\ntheme. [Learn more about supporting focal points in your theme](https://shopify.dev/themes/architecture/settings/input-settings#image-focal-points).\n\n> Tip:\n> Use the [`image_tag`](/docs/api/liquid/filters/image_tag) filter to automatically apply focal point settings to an\n> image on the storefront. This applies the focal point using the `object-position` CSS property.",
|
5002
5048
|
"properties": [
|
5003
5049
|
{
|
5004
5050
|
"deprecated": false,
|
@@ -5072,7 +5118,7 @@
|
|
5072
5118
|
},
|
5073
5119
|
"deprecated": false,
|
5074
5120
|
"deprecation_reason": "",
|
5075
|
-
"description": "You can use the `font` object in Liquid [assets](/themes/architecture#assets) or inside a [`style` tag](/api/liquid/tags/style)\nto apply font setting values to theme CSS.\n\n> Tip:\n> Use [font filters](/api/liquid/filters/font-filters) to modify properties of the `font` object, load the font,\n> or obtain font variants.",
|
5121
|
+
"description": "You can use the `font` object in Liquid [assets](/themes/architecture#assets) or inside a [`style` tag](/docs/api/liquid/tags/style)\nto apply font setting values to theme CSS.\n\n> Tip:\n> Use [font filters](/docs/api/liquid/filters/font-filters) to modify properties of the `font` object, load the font,\n> or obtain font variants.",
|
5076
5122
|
"properties": [
|
5077
5123
|
{
|
5078
5124
|
"deprecated": false,
|
@@ -5185,7 +5231,7 @@
|
|
5185
5231
|
{
|
5186
5232
|
"deprecated": false,
|
5187
5233
|
"deprecation_reason": "",
|
5188
|
-
"description": "> Tip:\n> You can use this property to determine whether you need to include a corresponding [font-face](/api/liquid/filters/font_face)\n> declaration for the font.",
|
5234
|
+
"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.",
|
5189
5235
|
"examples": [
|
5190
5236
|
|
5191
5237
|
],
|
@@ -5232,7 +5278,7 @@
|
|
5232
5278
|
{
|
5233
5279
|
"deprecated": false,
|
5234
5280
|
"deprecation_reason": "",
|
5235
|
-
"description": "If there are no errors, then `nil` is returned.\n\n> Tip:\n> You can apply the [`default_errors` filter](/api/liquid/filters/default_errors) to `form.errors` to output default\n> error messages without having to loop through the array.",
|
5281
|
+
"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.",
|
5236
5282
|
"examples": [
|
5237
5283
|
|
5238
5284
|
],
|
@@ -5250,7 +5296,7 @@
|
|
5250
5296
|
{
|
5251
5297
|
"deprecated": false,
|
5252
5298
|
"deprecation_reason": "",
|
5253
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5299
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5254
5300
|
"examples": [
|
5255
5301
|
|
5256
5302
|
],
|
@@ -5268,7 +5314,7 @@
|
|
5268
5314
|
{
|
5269
5315
|
"deprecated": false,
|
5270
5316
|
"deprecation_reason": "",
|
5271
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5317
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5272
5318
|
"examples": [
|
5273
5319
|
|
5274
5320
|
],
|
@@ -5286,7 +5332,7 @@
|
|
5286
5332
|
{
|
5287
5333
|
"deprecated": false,
|
5288
5334
|
"deprecation_reason": "",
|
5289
|
-
"description": "This property is exclusive to the [`new_comment` form](/api/liquid/tags/form#form-new_comment).",
|
5335
|
+
"description": "This property is exclusive to the [`new_comment` form](/docs/api/liquid/tags/form#form-new_comment).",
|
5290
5336
|
"examples": [
|
5291
5337
|
|
5292
5338
|
],
|
@@ -5304,7 +5350,7 @@
|
|
5304
5350
|
{
|
5305
5351
|
"deprecated": false,
|
5306
5352
|
"deprecation_reason": "",
|
5307
|
-
"description": "This property is exclusive to the [`contact`](/api/liquid/tags/form#form-contact) and [`new_comment`](/api/liquid/tags/form#form-new_comment)\nforms.",
|
5353
|
+
"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.",
|
5308
5354
|
"examples": [
|
5309
5355
|
|
5310
5356
|
],
|
@@ -5322,7 +5368,7 @@
|
|
5322
5368
|
{
|
5323
5369
|
"deprecated": false,
|
5324
5370
|
"deprecation_reason": "",
|
5325
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5371
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5326
5372
|
"examples": [
|
5327
5373
|
|
5328
5374
|
],
|
@@ -5340,7 +5386,7 @@
|
|
5340
5386
|
{
|
5341
5387
|
"deprecated": false,
|
5342
5388
|
"deprecation_reason": "",
|
5343
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5389
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5344
5390
|
"examples": [
|
5345
5391
|
|
5346
5392
|
],
|
@@ -5358,7 +5404,7 @@
|
|
5358
5404
|
{
|
5359
5405
|
"deprecated": false,
|
5360
5406
|
"deprecation_reason": "",
|
5361
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5407
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5362
5408
|
"examples": [
|
5363
5409
|
|
5364
5410
|
],
|
@@ -5376,7 +5422,7 @@
|
|
5376
5422
|
{
|
5377
5423
|
"deprecated": false,
|
5378
5424
|
"deprecation_reason": "",
|
5379
|
-
"description": "This property is exclusive to the following forms:\n\n- [`contact`](/api/liquid/tags/form#form-contact)\n- [`create_customer`](/api/liquid/tags/form#form-create_customer)\n- [`customer`](/api/liquid/tags/form#form-customer)\n- [`customer_login`](/api/liquid/tags/form#form-customer_login)\n- [`new_comment`](/api/liquid/tags/form#form-new_comment)\n- [`recover_customer_password`](/api/liquid/tags/form#form-recover_customer_password)",
|
5425
|
+
"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)",
|
5380
5426
|
"examples": [
|
5381
5427
|
|
5382
5428
|
],
|
@@ -5394,7 +5440,7 @@
|
|
5394
5440
|
{
|
5395
5441
|
"deprecated": false,
|
5396
5442
|
"deprecation_reason": "",
|
5397
|
-
"description": "This property is exclusive to the [`create_customer`](/api/liquid/tags/form#form-create_customer) and\n[`customer_address`](/api/liquid/tags/form#form-customer_address) forms.",
|
5443
|
+
"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.",
|
5398
5444
|
"examples": [
|
5399
5445
|
|
5400
5446
|
],
|
@@ -5430,7 +5476,7 @@
|
|
5430
5476
|
{
|
5431
5477
|
"deprecated": false,
|
5432
5478
|
"deprecation_reason": "",
|
5433
|
-
"description": "This property is exclusive to the [`create_customer`](/api/liquid/tags/form#form-create_customer) and\n[`customer_address`](/api/liquid/tags/form#form-customer_address) forms.",
|
5479
|
+
"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.",
|
5434
5480
|
"examples": [
|
5435
5481
|
|
5436
5482
|
],
|
@@ -5448,7 +5494,7 @@
|
|
5448
5494
|
{
|
5449
5495
|
"deprecated": false,
|
5450
5496
|
"deprecation_reason": "",
|
5451
|
-
"description": "This property is exclusive to the [`customer_login` form](/api/liquid/tags/form#form-customer_login).",
|
5497
|
+
"description": "This property is exclusive to the [`customer_login` form](/docs/api/liquid/tags/form#form-customer_login).",
|
5452
5498
|
"examples": [
|
5453
5499
|
|
5454
5500
|
],
|
@@ -5466,7 +5512,7 @@
|
|
5466
5512
|
{
|
5467
5513
|
"deprecated": false,
|
5468
5514
|
"deprecation_reason": "",
|
5469
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5515
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5470
5516
|
"examples": [
|
5471
5517
|
|
5472
5518
|
],
|
@@ -5484,7 +5530,7 @@
|
|
5484
5530
|
{
|
5485
5531
|
"deprecated": false,
|
5486
5532
|
"deprecation_reason": "",
|
5487
|
-
"description": "> Note:\n> The [`customer_address` form](/api/liquid/tags/form#form-customer_address) always returns `true`.",
|
5533
|
+
"description": "> Note:\n> The [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address) always returns `true`.",
|
5488
5534
|
"examples": [
|
5489
5535
|
|
5490
5536
|
],
|
@@ -5502,7 +5548,7 @@
|
|
5502
5548
|
{
|
5503
5549
|
"deprecated": false,
|
5504
5550
|
"deprecation_reason": "",
|
5505
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5551
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5506
5552
|
"examples": [
|
5507
5553
|
|
5508
5554
|
],
|
@@ -5520,7 +5566,7 @@
|
|
5520
5566
|
{
|
5521
5567
|
"deprecated": false,
|
5522
5568
|
"deprecation_reason": "",
|
5523
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5569
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5524
5570
|
"examples": [
|
5525
5571
|
|
5526
5572
|
],
|
@@ -5538,7 +5584,7 @@
|
|
5538
5584
|
{
|
5539
5585
|
"deprecated": false,
|
5540
5586
|
"deprecation_reason": "",
|
5541
|
-
"description": "This property is exclusive to the [`customer_address` form](/api/liquid/tags/form#form-customer_address).",
|
5587
|
+
"description": "This property is exclusive to the [`customer_address` form](/docs/api/liquid/tags/form#form-customer_address).",
|
5542
5588
|
"examples": [
|
5543
5589
|
|
5544
5590
|
],
|
@@ -5554,7 +5600,7 @@
|
|
5554
5600
|
"name": "zip"
|
5555
5601
|
}
|
5556
5602
|
],
|
5557
|
-
"summary": "Information about a form created by a [`form` tag](/api/liquid/tags/form).",
|
5603
|
+
"summary": "Information about a form created by a [`form` tag](/docs/api/liquid/tags/form).",
|
5558
5604
|
"name": "form",
|
5559
5605
|
"examples": [
|
5560
5606
|
|
@@ -5588,7 +5634,7 @@
|
|
5588
5634
|
{
|
5589
5635
|
"deprecated": false,
|
5590
5636
|
"deprecation_reason": "",
|
5591
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
5637
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
5592
5638
|
"examples": [
|
5593
5639
|
|
5594
5640
|
],
|
@@ -5812,7 +5858,7 @@
|
|
5812
5858
|
"array_value": ""
|
5813
5859
|
}
|
5814
5860
|
],
|
5815
|
-
"summary": "The position of the media in the [`product.media` array](/api/liquid/objects/product#product-media).",
|
5861
|
+
"summary": "The position of the media in the [`product.media` array](/docs/api/liquid/objects/product#product-media).",
|
5816
5862
|
"name": "position"
|
5817
5863
|
},
|
5818
5864
|
{
|
@@ -5834,7 +5880,7 @@
|
|
5834
5880
|
"name": "alt"
|
5835
5881
|
}
|
5836
5882
|
],
|
5837
|
-
"summary": "A file from a `file_reference` type [metafield](/api/liquid/objects/metafield) that is neither an image or video.",
|
5883
|
+
"summary": "A file from a `file_reference` type [metafield](/docs/api/liquid/objects/metafield) that is neither an image or video.",
|
5838
5884
|
"name": "generic_file",
|
5839
5885
|
"examples": [
|
5840
5886
|
|
@@ -5865,7 +5911,7 @@
|
|
5865
5911
|
{
|
5866
5912
|
"deprecated": false,
|
5867
5913
|
"deprecation_reason": "",
|
5868
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
5914
|
+
"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.",
|
5869
5915
|
"examples": [
|
5870
5916
|
|
5871
5917
|
],
|
@@ -5934,6 +5980,42 @@
|
|
5934
5980
|
"summary": "The customer associated with the gift card.",
|
5935
5981
|
"name": "customer"
|
5936
5982
|
},
|
5983
|
+
{
|
5984
|
+
"deprecated": false,
|
5985
|
+
"deprecation_reason": "",
|
5986
|
+
"description": "If there is no recipient associated with the gift card, then `nil` is returned.",
|
5987
|
+
"examples": [
|
5988
|
+
|
5989
|
+
],
|
5990
|
+
"return_type": [
|
5991
|
+
{
|
5992
|
+
"type": "recipient",
|
5993
|
+
"name": "",
|
5994
|
+
"description": "",
|
5995
|
+
"array_value": ""
|
5996
|
+
}
|
5997
|
+
],
|
5998
|
+
"summary": "The recipient associated with the gift card.",
|
5999
|
+
"name": "recipient"
|
6000
|
+
},
|
6001
|
+
{
|
6002
|
+
"deprecated": false,
|
6003
|
+
"deprecation_reason": "",
|
6004
|
+
"description": "If there is no message intended for the recipient, then `nil` is returned.",
|
6005
|
+
"examples": [
|
6006
|
+
|
6007
|
+
],
|
6008
|
+
"return_type": [
|
6009
|
+
{
|
6010
|
+
"type": "string",
|
6011
|
+
"name": "",
|
6012
|
+
"description": "",
|
6013
|
+
"array_value": ""
|
6014
|
+
}
|
6015
|
+
],
|
6016
|
+
"summary": "The personalized message intended for the recipient.",
|
6017
|
+
"name": "message"
|
6018
|
+
},
|
5937
6019
|
{
|
5938
6020
|
"deprecated": false,
|
5939
6021
|
"deprecation_reason": "",
|
@@ -5973,7 +6055,7 @@
|
|
5973
6055
|
{
|
5974
6056
|
"deprecated": false,
|
5975
6057
|
"deprecation_reason": "",
|
5976
|
-
"description": "If the gift card never expires, then `nil` is returned.\n> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
6058
|
+
"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.",
|
5977
6059
|
"examples": [
|
5978
6060
|
|
5979
6061
|
],
|
@@ -5991,7 +6073,7 @@
|
|
5991
6073
|
{
|
5992
6074
|
"deprecated": false,
|
5993
6075
|
"deprecation_reason": "",
|
5994
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
6076
|
+
"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.",
|
5995
6077
|
"examples": [
|
5996
6078
|
|
5997
6079
|
],
|
@@ -6045,7 +6127,7 @@
|
|
6045
6127
|
{
|
6046
6128
|
"deprecated": false,
|
6047
6129
|
"deprecation_reason": "",
|
6048
|
-
"description": "If there aren't any line item properties, then an [`EmptyDrop`](/api/liquid/basics#emptydrop) is returned.",
|
6130
|
+
"description": "If there aren't any line item properties, then an [`EmptyDrop`](/docs/api/liquid/basics#emptydrop) is returned.",
|
6049
6131
|
"examples": [
|
6050
6132
|
|
6051
6133
|
],
|
@@ -6057,7 +6139,7 @@
|
|
6057
6139
|
"array_value": "untyped"
|
6058
6140
|
}
|
6059
6141
|
],
|
6060
|
-
"summary": "The [line item properties](/api/liquid/objects/line_item#line_item-properties) assigned to the gift card.",
|
6142
|
+
"summary": "The [line item properties](/docs/api/liquid/objects/line_item#line_item-properties) assigned to the gift card.",
|
6061
6143
|
"name": "properties"
|
6062
6144
|
},
|
6063
6145
|
{
|
@@ -6133,7 +6215,7 @@
|
|
6133
6215
|
"name": "last_four_characters"
|
6134
6216
|
}
|
6135
6217
|
],
|
6136
|
-
"summary": "A [gift card](https://help.shopify.com/manual/products/gift-card-products) that's been issued to a customer.",
|
6218
|
+
"summary": "A [gift card](https://help.shopify.com/manual/products/gift-card-products) that's been issued to a customer or a recipient.",
|
6137
6219
|
"name": "gift_card",
|
6138
6220
|
"examples": [
|
6139
6221
|
|
@@ -6141,7 +6223,7 @@
|
|
6141
6223
|
"json_data": {
|
6142
6224
|
"path": "",
|
6143
6225
|
"handle": "",
|
6144
|
-
"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\",\"pass_url\":\"https://polinas-potent-potions.myshopify.com/v1/passes/pass.com.shopify.giftcardnext/94af7fbe55d010130df8d8bc4a338d36/\",\"product\":{},\"properties\":{},\"qr_identifier\":\"shopify-giftcard-v1-3TKWJKJBM3X7PBRK\",\"template_suffix\":null,\"url\":\"https://checkout.shopify.com/gift_cards/56174706753/0011c591fc720d0a51b80cdb694f969e\"}"
|
6226
|
+
"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,\"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\"}"
|
6145
6227
|
},
|
6146
6228
|
"return_type": [
|
6147
6229
|
|
@@ -6230,7 +6312,7 @@
|
|
6230
6312
|
},
|
6231
6313
|
"deprecated": false,
|
6232
6314
|
"deprecation_reason": "",
|
6233
|
-
"description": "To learn about the image formats that Shopify supports, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/images/theme-images#image-formats).\n\n> Tip:\n> Use the [`image_url`](/api/liquid/filters/image_url) and [`image_tag`](/api/liquid/filters/image_tag) filters to display\n> images on the storefront.",
|
6315
|
+
"description": "To learn about the image formats that Shopify supports, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/images/theme-images#image-formats).\n\n> Tip:\n> Use the [`image_url`](/docs/api/liquid/filters/image_url) and [`image_tag`](/docs/api/liquid/filters/image_tag) filters to display\n> images on the storefront.",
|
6234
6316
|
"properties": [
|
6235
6317
|
{
|
6236
6318
|
"deprecated": false,
|
@@ -6343,7 +6425,7 @@
|
|
6343
6425
|
{
|
6344
6426
|
"deprecated": false,
|
6345
6427
|
"deprecation_reason": "",
|
6346
|
-
"description": "The `attached_to_variant?` property is only available for images accessed through the following sources:\n\n- [`product.featured_image`](/api/liquid/objects/product#product-featured_image)\n- [`product.images`](/api/liquid/objects/product#product-images)\n\nIf you reference this property on an image from another source, then `nil` is returned.",
|
6428
|
+
"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.",
|
6347
6429
|
"examples": [
|
6348
6430
|
|
6349
6431
|
],
|
@@ -6361,7 +6443,7 @@
|
|
6361
6443
|
{
|
6362
6444
|
"deprecated": false,
|
6363
6445
|
"deprecation_reason": "",
|
6364
|
-
"description": "If you reference the `id` property for preview images of [`generic_file`](/api/liquid/objects/generic_file) or\n[`media`](/api/liquid/objects/media) objects, then `nil` is returned.",
|
6446
|
+
"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.",
|
6365
6447
|
"examples": [
|
6366
6448
|
|
6367
6449
|
],
|
@@ -6379,11 +6461,11 @@
|
|
6379
6461
|
{
|
6380
6462
|
"deprecated": false,
|
6381
6463
|
"deprecation_reason": "",
|
6382
|
-
"description": "The `media_type` property is only available for images accessed through the following sources:\n\n- [`product.media`](/api/liquid/objects/product#product-media)\n- [`file_reference` type metafields](/apps/metafields/types#supported-types)\n\nIf you reference this property on an image from another source, then `nil` is returned.",
|
6464
|
+
"description": "The `media_type` property is only available for images accessed through the following sources:\n\n- [`product.media`](/docs/api/liquid/objects/product#product-media)\n- [`file_reference` type metafields](/apps/metafields/types#supported-types)\n\nIf you reference this property on an image from another source, then `nil` is returned.",
|
6383
6465
|
"examples": [
|
6384
6466
|
{
|
6385
6467
|
"name": "Filter for media of a specific type",
|
6386
|
-
"description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
6468
|
+
"description": "You can use the `media_type` property with the [`where` filter](/docs/api/liquid/filters/where) to filter the [`product.media` array](/docs/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
6387
6469
|
"syntax": "",
|
6388
6470
|
"path": "/products/snake-venom",
|
6389
6471
|
"raw_liquid": "{% assign images = product.media | where: 'media_type', 'image' %}\n\n{% for image in images %}\n {{- image | image_url: width: 300 | image_tag }}\n{% endfor %}",
|
@@ -6418,13 +6500,13 @@
|
|
6418
6500
|
"array_value": ""
|
6419
6501
|
}
|
6420
6502
|
],
|
6421
|
-
"summary": "The position of the image in the [`product.images`](/api/liquid/objects/product#product-images) or [`product.media`](/api/liquid/objects/product#product-media)\narray.",
|
6503
|
+
"summary": "The position of the image in the [`product.images`](/docs/api/liquid/objects/product#product-images) or [`product.media`](/docs/api/liquid/objects/product#product-media)\narray.",
|
6422
6504
|
"name": "position"
|
6423
6505
|
},
|
6424
6506
|
{
|
6425
6507
|
"deprecated": false,
|
6426
6508
|
"deprecation_reason": "",
|
6427
|
-
"description": "The `preview_image` property is only available for images accessed through the following sources:\n\n- [`product.featured_media`](/api/liquid/objects/product#product-featured_media)\n- [`product.media`](/api/liquid/objects/product#product-media)\n- [`file_reference` type metafields](/apps/metafields/types#supported-types)\n\nIf you reference this property on an image from another source, then `nil` is returned.",
|
6509
|
+
"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.",
|
6428
6510
|
"examples": [
|
6429
6511
|
|
6430
6512
|
],
|
@@ -6460,7 +6542,7 @@
|
|
6460
6542
|
{
|
6461
6543
|
"deprecated": false,
|
6462
6544
|
"deprecation_reason": "",
|
6463
|
-
"description": "The `variants` property is only available for images accessed through the following sources:\n\n- [`product.featured_image`](/api/liquid/objects#product-featured_image)\n- [`product.images`](/api/liquid/objects/product#product-images)\n\nIf you reference this property on an image from another source, then `nil` is returned.",
|
6545
|
+
"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.",
|
6464
6546
|
"examples": [
|
6465
6547
|
|
6466
6548
|
],
|
@@ -6570,7 +6652,7 @@
|
|
6570
6652
|
"properties": [
|
6571
6653
|
|
6572
6654
|
],
|
6573
|
-
"summary": "All of the [images](/api/liquid/objects/image) that have been [uploaded](https://help.shopify.com/manual/online-store/images/theme-images#upload-images)\nto a store.",
|
6655
|
+
"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.",
|
6574
6656
|
"name": "images",
|
6575
6657
|
"examples": [
|
6576
6658
|
{
|
@@ -6626,7 +6708,7 @@
|
|
6626
6708
|
{
|
6627
6709
|
"deprecated": false,
|
6628
6710
|
"deprecation_reason": "",
|
6629
|
-
"description": "The ID differs depending on the context. The following table outlines the possible contexts and their associated values:\n\n| Context | Value |\n| --- | --- |\n| [`cart.items`](/api/liquid/objects/cart#cart-items) | The ID of the line item's variant.<br><br>This ID isn't unique, and can be shared by multiple items with the same variant. |\n| [`checkout.line_items`](/api/liquid/objects/checkout#checkout-line_items) | A temporary unique hash generated for the checkout. |\n| [`order.line_items`](/api/liquid/objects/order#order-line_items) | A unique integer ID. |",
|
6711
|
+
"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. |",
|
6630
6712
|
"examples": [
|
6631
6713
|
|
6632
6714
|
],
|
@@ -6661,8 +6743,8 @@
|
|
6661
6743
|
},
|
6662
6744
|
{
|
6663
6745
|
"deprecated": true,
|
6664
|
-
"deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.price` property has been replaced by [`line_item.final_price`](/api/liquid/objects/line_item#line_item-final_price).",
|
6665
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
6746
|
+
"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).",
|
6747
|
+
"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.",
|
6666
6748
|
"examples": [
|
6667
6749
|
|
6668
6750
|
],
|
@@ -6679,8 +6761,8 @@
|
|
6679
6761
|
},
|
6680
6762
|
{
|
6681
6763
|
"deprecated": true,
|
6682
|
-
"deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.line_price` property has been replaced by [`line_item.final_line_price`](/api/liquid/objects/line_item#line_item-final_line_price).",
|
6683
|
-
"description": "The value is equal to `line_item.price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
6764
|
+
"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).",
|
6765
|
+
"description": "The value is equal to `line_item.price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
6684
6766
|
"examples": [
|
6685
6767
|
|
6686
6768
|
],
|
@@ -6697,8 +6779,8 @@
|
|
6697
6779
|
},
|
6698
6780
|
{
|
6699
6781
|
"deprecated": true,
|
6700
|
-
"deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.total_discount` property has been replaced by [`line_item.line_level_total_discount`](/api/liquid/objects/line_item#line_item-line_level_total_discount).",
|
6701
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
6782
|
+
"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).",
|
6783
|
+
"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.",
|
6702
6784
|
"examples": [
|
6703
6785
|
|
6704
6786
|
],
|
@@ -6734,7 +6816,7 @@
|
|
6734
6816
|
{
|
6735
6817
|
"deprecated": false,
|
6736
6818
|
"deprecation_reason": "",
|
6737
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
6819
|
+
"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.",
|
6738
6820
|
"examples": [
|
6739
6821
|
|
6740
6822
|
],
|
@@ -6752,7 +6834,7 @@
|
|
6752
6834
|
{
|
6753
6835
|
"deprecated": false,
|
6754
6836
|
"deprecation_reason": "",
|
6755
|
-
"description": "The value is equal to `line_item.final_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
6837
|
+
"description": "The value is equal to `line_item.final_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
6756
6838
|
"examples": [
|
6757
6839
|
|
6758
6840
|
],
|
@@ -6782,7 +6864,7 @@
|
|
6782
6864
|
"array_value": ""
|
6783
6865
|
}
|
6784
6866
|
],
|
6785
|
-
"summary": "The [ID](/api/liquid/objects/variant#variant-id) of the line item's variant.",
|
6867
|
+
"summary": "The [ID](/docs/api/liquid/objects/variant#variant-id) of the line item's variant.",
|
6786
6868
|
"name": "variant_id"
|
6787
6869
|
},
|
6788
6870
|
{
|
@@ -6800,7 +6882,7 @@
|
|
6800
6882
|
"array_value": ""
|
6801
6883
|
}
|
6802
6884
|
],
|
6803
|
-
"summary": "The [ID](/api/liquid/objects/product#product-id) of the line item's product.",
|
6885
|
+
"summary": "The [ID](/docs/api/liquid/objects/product#product-id) of the line item's product.",
|
6804
6886
|
"name": "product_id"
|
6805
6887
|
},
|
6806
6888
|
{
|
@@ -6918,7 +7000,7 @@
|
|
6918
7000
|
"examples": [
|
6919
7001
|
{
|
6920
7002
|
"name": "Capture line item properties in the product form",
|
6921
|
-
"description": "To capture line item properties inside the [product form](/api/liquid/tags/form#form-product), you need to include an input, for each property. Each input needs a unique `name` attribute. Use the following format:\n\n```\nname=\"properties[property-name]\"\n```\n\nThe value of the input is captured as the value of the property.\n\nFor example, you can use the following code to capture custom engraving text for a product:\n\n```liquid\n{% form 'product', product %}\n ...\n <label for=\"engravingText\">Engraving<label>\n <input type=\"text\" id=\"engravingText\" name=\"properties[Engraving]\">\n ...\n{% endform %}\n```\n\n> Tip:\n> You can add an underscore to the beginning of a property name to hide it from customers at checkout. For example,\n> `properties[_hiddenPropertyName]`.\n",
|
7003
|
+
"description": "To capture line item properties inside the [product form](/docs/api/liquid/tags/form#form-product), you need to include an input, for each property. Each input needs a unique `name` attribute. Use the following format:\n\n```\nname=\"properties[property-name]\"\n```\n\nThe value of the input is captured as the value of the property.\n\nFor example, you can use the following code to capture custom engraving text for a product:\n\n```liquid\n{% form 'product', product %}\n ...\n <label for=\"engravingText\">Engraving<label>\n <input type=\"text\" id=\"engravingText\" name=\"properties[Engraving]\">\n ...\n{% endform %}\n```\n\n> Tip:\n> You can add an underscore to the beginning of a property name to hide it from customers at checkout. For example,\n> `properties[_hiddenPropertyName]`.\n",
|
6922
7004
|
"syntax": "",
|
6923
7005
|
"path": "/products/health-potion",
|
6924
7006
|
"raw_liquid": "",
|
@@ -6959,7 +7041,7 @@
|
|
6959
7041
|
{
|
6960
7042
|
"deprecated": false,
|
6961
7043
|
"deprecation_reason": "",
|
6962
|
-
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
7044
|
+
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
6963
7045
|
"examples": [
|
6964
7046
|
|
6965
7047
|
],
|
@@ -6989,13 +7071,13 @@
|
|
6989
7071
|
"array_value": ""
|
6990
7072
|
}
|
6991
7073
|
],
|
6992
|
-
"summary": "The [sku](/api/liquid/objects/variant#variant-sku) of the variant associated with the line item.",
|
7074
|
+
"summary": "The [sku](/docs/api/liquid/objects/variant#variant-sku) of the variant associated with the line item.",
|
6993
7075
|
"name": "sku"
|
6994
7076
|
},
|
6995
7077
|
{
|
6996
7078
|
"deprecated": false,
|
6997
7079
|
"deprecation_reason": "",
|
6998
|
-
"description": "The following table outlines what's returned depending on the number of discounts affecting the line item:\n\n| Number of discounts | Value |\n| --- | --- |\n| 0 | `nil` |\n| 1 | The [title](/api/liquid/objects/discount_application#discount_application-title) of the discount. |\n| More than 1 | A Shopify generated string noting how many discounts have been applied. |",
|
7080
|
+
"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. |",
|
6999
7081
|
"examples": [
|
7000
7082
|
|
7001
7083
|
],
|
@@ -7031,7 +7113,7 @@
|
|
7031
7113
|
{
|
7032
7114
|
"deprecated": false,
|
7033
7115
|
"deprecation_reason": "",
|
7034
|
-
"description": "In most contexts, the line item title appears in the customer's preferred language. However, in the context of an\n[order](/api/liquid/objects/order), the line item title appears in the language that the customer checked out in.\n\n#### Line item title history\n\nWhen referencing line item, product, and variant titles in the context of an order, the following changes might result\nin a different output than you expect:\n\n- A product or variant being deleted\n- A product or variant title being edited\n\nWhen `line_item.title` is referenced for an order, the line item title at the time of the order is returned.\nHowever, when `line_item.product.title` and `line_item.variant.title` are referenced, the current value for\neach title is returned.",
|
7116
|
+
"description": "In most contexts, the line item title appears in the customer's preferred language. However, in the context of an\n[order](/docs/api/liquid/objects/order), the line item title appears in the language that the customer checked out in.\n\n#### Line item title history\n\nWhen referencing line item, product, and variant titles in the context of an order, the following changes might result\nin a different output than you expect:\n\n- A product or variant being deleted\n- A product or variant title being edited\n\nWhen `line_item.title` is referenced for an order, the line item title at the time of the order is returned.\nHowever, when `line_item.product.title` and `line_item.variant.title` are referenced, the current value for\neach title is returned.",
|
7035
7117
|
"examples": [
|
7036
7118
|
|
7037
7119
|
],
|
@@ -7067,7 +7149,7 @@
|
|
7067
7149
|
{
|
7068
7150
|
"deprecated": false,
|
7069
7151
|
"deprecation_reason": "",
|
7070
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
7152
|
+
"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.",
|
7071
7153
|
"examples": [
|
7072
7154
|
|
7073
7155
|
],
|
@@ -7085,7 +7167,7 @@
|
|
7085
7167
|
{
|
7086
7168
|
"deprecated": false,
|
7087
7169
|
"deprecation_reason": "",
|
7088
|
-
"description": "The value is equal to `line_item.original_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
7170
|
+
"description": "The value is equal to `line_item.original_price` multiplied by `line_item.quantity`. It's output in the customer's local\n(presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
7089
7171
|
"examples": [
|
7090
7172
|
|
7091
7173
|
],
|
@@ -7103,7 +7185,7 @@
|
|
7103
7185
|
{
|
7104
7186
|
"deprecated": false,
|
7105
7187
|
"deprecation_reason": "",
|
7106
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
7188
|
+
"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.",
|
7107
7189
|
"examples": [
|
7108
7190
|
|
7109
7191
|
],
|
@@ -7138,7 +7220,7 @@
|
|
7138
7220
|
},
|
7139
7221
|
{
|
7140
7222
|
"deprecated": true,
|
7141
|
-
"deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.discounts` property has been replaced by [`line_item.discount_allocations`](/api/liquid/objects/line_item#line_item-discount_allocations).",
|
7223
|
+
"deprecation_reason": "Deprecated because discounts from automatic discounts and discount codes aren't included.\n\nThe `line_item.discounts` property has been replaced by [`line_item.discount_allocations`](/docs/api/liquid/objects/line_item#line_item-discount_allocations).",
|
7142
7224
|
"description": "",
|
7143
7225
|
"examples": [
|
7144
7226
|
|
@@ -7192,7 +7274,7 @@
|
|
7192
7274
|
},
|
7193
7275
|
{
|
7194
7276
|
"deprecated": true,
|
7195
|
-
"deprecation_reason": "Deprecated because not all discount types and details are available.\n\nThe `line_item.discounts` property has been replaced by [`line_item.discount_allocations`](/api/liquid/objects/line_item#line_item-discount_allocations).",
|
7277
|
+
"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).",
|
7196
7278
|
"description": "",
|
7197
7279
|
"examples": [
|
7198
7280
|
|
@@ -7256,7 +7338,7 @@
|
|
7256
7338
|
{
|
7257
7339
|
"deprecated": false,
|
7258
7340
|
"deprecation_reason": "",
|
7259
|
-
"description": "> Tip:\n> Use this property with the [`weight_with_unit` filter](/api/liquid/filters/weight_with_unit) to format the weight.",
|
7341
|
+
"description": "> Tip:\n> Use this property with the [`weight_with_unit` filter](/docs/api/liquid/filters/weight_with_unit) to format the weight.",
|
7260
7342
|
"examples": [
|
7261
7343
|
|
7262
7344
|
],
|
@@ -7328,7 +7410,7 @@
|
|
7328
7410
|
{
|
7329
7411
|
"deprecated": false,
|
7330
7412
|
"deprecation_reason": "",
|
7331
|
-
"description": "#### Availability of selling plan information\n\nThe following properties aren't available when referencing selling plan information through an\n[order's line items](/api/liquid/objects/order#order-line_items):\n\n- [`selling_plan_allocation.compare_at_price`](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-compare_at_price)\n- [`selling_plan_allocation.price_adjustments`](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments)\n- [`selling_plan_allocation.selling_plan.group_id`](/api/liquid/objects/selling_plan#selling_plan-group_id)\n- [`selling_plan_allocation.selling_plan.options`](/api/liquid/objects/selling_plan#selling_plan-options)\n- [`selling_plan_allocation.selling_plan.price_adjustments`](/api/liquid/objects/selling_plan#selling_plan-price_adjustments)\n- [`selling_plan_allocation.selling_plan_group_id`](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-selling_plan_group_id)\n\n> Tip:\n> If you need to show selling plan information post-purchase, then you should use [`selling_plan.name`](/api/liquid/objects/selling_plan#selling_plan-name).",
|
7413
|
+
"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).",
|
7332
7414
|
"examples": [
|
7333
7415
|
|
7334
7416
|
],
|
@@ -7378,7 +7460,7 @@
|
|
7378
7460
|
{
|
7379
7461
|
"deprecated": false,
|
7380
7462
|
"deprecation_reason": "",
|
7381
|
-
"description": "A link is considered to be active if the current URL path matches, or contains, the link's [url](/api/liquid/objects/link#link-url).\nFor example, if the current URL path is `/blog/potion-notions/new-potions-for-spring`, then the following link URLs\nwould be considered active:\n\n- `/blog/potion-notions/new-potions-for-spring`\n- `/blog/potion-notions`\n\n> Tip:\n> The `link.active` property is useful for menu designs that highlight when top-level navigation categories are being\n> viewed. For example, if a customer is viewing an article from the \"Potion notions\" blog, then the \"Potion notions\" link\n> is highlighted in the menu.",
|
7463
|
+
"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.",
|
7382
7464
|
"examples": [
|
7383
7465
|
|
7384
7466
|
],
|
@@ -7396,7 +7478,7 @@
|
|
7396
7478
|
{
|
7397
7479
|
"deprecated": false,
|
7398
7480
|
"deprecation_reason": "",
|
7399
|
-
"description": "> Note:\n> URL parameters are ignored when determining a match.\n>\n> Product URLs [within the context of a collection](/api/liquid/filters/within) are treated as equal to a standard product\n> URL for the same product.",
|
7481
|
+
"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.",
|
7400
7482
|
"examples": [
|
7401
7483
|
|
7402
7484
|
],
|
@@ -7408,13 +7490,13 @@
|
|
7408
7490
|
"array_value": ""
|
7409
7491
|
}
|
7410
7492
|
],
|
7411
|
-
"summary": "Returns `true` if the current URL path matches the [URL](/api/liquid/objects/link#link-url) of the link. Returns `false` if not.",
|
7493
|
+
"summary": "Returns `true` if the current URL path matches the [URL](/docs/api/liquid/objects/link#link-url) of the link. Returns `false` if not.",
|
7412
7494
|
"name": "current"
|
7413
7495
|
},
|
7414
7496
|
{
|
7415
7497
|
"deprecated": false,
|
7416
7498
|
"deprecation_reason": "",
|
7417
|
-
"description": "A link is considered to be active if the current URL path matches, or contains, the [URL](/api/liquid/objects/link#link-url) of\nthe link.\n\nFor example, if the current URL path is `/blog/potion-notions/new-potions-for-spring`, then the following link URLs\nwould be considered active:\n\n- `/blog/potion-notions/new-potions-for-spring`\n- `/blog/potion-notions`",
|
7499
|
+
"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`",
|
7418
7500
|
"examples": [
|
7419
7501
|
|
7420
7502
|
],
|
@@ -7432,7 +7514,7 @@
|
|
7432
7514
|
{
|
7433
7515
|
"deprecated": false,
|
7434
7516
|
"deprecation_reason": "",
|
7435
|
-
"description": "> Note:\n> URL parameters are ignored when determining a match.\n>\n> Product URLs [within the context of a collection](/api/liquid/filters/within) and standard product URLs are treated\n> the same.",
|
7517
|
+
"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.",
|
7436
7518
|
"examples": [
|
7437
7519
|
|
7438
7520
|
],
|
@@ -7444,7 +7526,7 @@
|
|
7444
7526
|
"array_value": ""
|
7445
7527
|
}
|
7446
7528
|
],
|
7447
|
-
"summary": "Returns `true` if current URL path matches a link's child link [URL](/api/liquid/objects/link#link-url). Returns `false` if not.",
|
7529
|
+
"summary": "Returns `true` if current URL path matches a link's child link [URL](/docs/api/liquid/objects/link#link-url). Returns `false` if not.",
|
7448
7530
|
"name": "child_current"
|
7449
7531
|
},
|
7450
7532
|
{
|
@@ -7462,7 +7544,7 @@
|
|
7462
7544
|
"array_value": ""
|
7463
7545
|
}
|
7464
7546
|
],
|
7465
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the link.",
|
7547
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the link.",
|
7466
7548
|
"name": "handle"
|
7467
7549
|
},
|
7468
7550
|
{
|
@@ -7495,7 +7577,7 @@
|
|
7495
7577
|
{
|
7496
7578
|
"deprecated": false,
|
7497
7579
|
"deprecation_reason": "",
|
7498
|
-
"description": "The object can be one of the following:\n\n- [`article`](/api/liquid/objects/article)\n- [`blog`](/api/liquid/objects/blog)\n- [`collection`](/api/liquid/objects/collection)\n- [`page`](/api/liquid/objects/page)\n- [`policy`](/api/liquid/objects/policy)\n- [`product`](/api/liquid/objects/product)",
|
7580
|
+
"description": "The object can be one of the following:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`blog`](/docs/api/liquid/objects/blog)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`page`](/docs/api/liquid/objects/page)\n- [`policy`](/docs/api/liquid/objects/policy)\n- [`product`](/docs/api/liquid/objects/product)",
|
7499
7581
|
"examples": [
|
7500
7582
|
|
7501
7583
|
],
|
@@ -7678,7 +7760,7 @@
|
|
7678
7760
|
"examples": [
|
7679
7761
|
{
|
7680
7762
|
"name": "",
|
7681
|
-
"description": "You can access a specific menu through the `linklists` object using the menu's [handle](/api/liquid/basics#handles).\n",
|
7763
|
+
"description": "You can access a specific menu through the `linklists` object using the menu's [handle](/docs/api/liquid/basics#handles).\n",
|
7682
7764
|
"syntax": "",
|
7683
7765
|
"path": "/",
|
7684
7766
|
"raw_liquid": "<!-- Main menu -->\n{% for link in linklists.main-menu.links -%}\n {{ link.title | link_to: link.url }}\n{%- endfor %}\n\n<!-- Footer menu -->\n{% for link in linklists['footer'].links -%}\n {{ link.title | link_to: link.url }}\n{%- endfor %}",
|
@@ -7751,7 +7833,7 @@
|
|
7751
7833
|
"array_value": ""
|
7752
7834
|
}
|
7753
7835
|
],
|
7754
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the menu.",
|
7836
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the menu.",
|
7755
7837
|
"name": "handle"
|
7756
7838
|
},
|
7757
7839
|
{
|
@@ -7976,7 +8058,7 @@
|
|
7976
8058
|
"name": "last"
|
7977
8059
|
}
|
7978
8060
|
],
|
7979
|
-
"summary": "Information about a parent [`for` loop](/api/liquid/tags/for).",
|
8061
|
+
"summary": "Information about a parent [`for` loop](/docs/api/liquid/tags/for).",
|
7980
8062
|
"name": "forloop",
|
7981
8063
|
"examples": [
|
7982
8064
|
{
|
@@ -8230,7 +8312,7 @@
|
|
8230
8312
|
"name": "col_last"
|
8231
8313
|
}
|
8232
8314
|
],
|
8233
|
-
"summary": "Information about a parent [`tablerow` loop](/api/liquid/tags/tablerow).",
|
8315
|
+
"summary": "Information about a parent [`tablerow` loop](/docs/api/liquid/tags/tablerow).",
|
8234
8316
|
"name": "tablerowloop",
|
8235
8317
|
"examples": [
|
8236
8318
|
|
@@ -8256,7 +8338,7 @@
|
|
8256
8338
|
},
|
8257
8339
|
"deprecated": false,
|
8258
8340
|
"deprecation_reason": "",
|
8259
|
-
"description": "The `localization` object can be used in a [localization form](/api/liquid/tags/form#form-localization).\n\nTo learn about how to offer localization options in your theme, refer to [Support multiple currencies and languages](/themes/internationalization/multiple-currencies-languages).",
|
8341
|
+
"description": "The `localization` object can be used in a [localization form](/docs/api/liquid/tags/form#form-localization).\n\nTo learn about how to offer localization options in your theme, refer to [Support multiple currencies and languages](/themes/internationalization/multiple-currencies-languages).",
|
8260
8342
|
"properties": [
|
8261
8343
|
{
|
8262
8344
|
"deprecated": false,
|
@@ -8300,6 +8382,24 @@
|
|
8300
8382
|
"description": "",
|
8301
8383
|
"examples": [
|
8302
8384
|
|
8385
|
+
],
|
8386
|
+
"return_type": [
|
8387
|
+
{
|
8388
|
+
"type": "market",
|
8389
|
+
"name": "",
|
8390
|
+
"description": "",
|
8391
|
+
"array_value": ""
|
8392
|
+
}
|
8393
|
+
],
|
8394
|
+
"summary": "The currently selected market on the storefront.",
|
8395
|
+
"name": "market"
|
8396
|
+
},
|
8397
|
+
{
|
8398
|
+
"deprecated": false,
|
8399
|
+
"deprecation_reason": "",
|
8400
|
+
"description": "",
|
8401
|
+
"examples": [
|
8402
|
+
|
8303
8403
|
],
|
8304
8404
|
"return_type": [
|
8305
8405
|
{
|
@@ -8467,7 +8567,7 @@
|
|
8467
8567
|
"array_value": ""
|
8468
8568
|
}
|
8469
8569
|
],
|
8470
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the location.",
|
8570
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the location.",
|
8471
8571
|
"name": "metafields"
|
8472
8572
|
}
|
8473
8573
|
],
|
@@ -8485,6 +8585,96 @@
|
|
8485
8585
|
|
8486
8586
|
]
|
8487
8587
|
},
|
8588
|
+
{
|
8589
|
+
"access": {
|
8590
|
+
"global": false,
|
8591
|
+
"parents": [
|
8592
|
+
{
|
8593
|
+
"object": "localization",
|
8594
|
+
"property": "market"
|
8595
|
+
},
|
8596
|
+
{
|
8597
|
+
"object": "country",
|
8598
|
+
"property": "market"
|
8599
|
+
}
|
8600
|
+
],
|
8601
|
+
"template": [
|
8602
|
+
|
8603
|
+
]
|
8604
|
+
},
|
8605
|
+
"deprecated": false,
|
8606
|
+
"deprecation_reason": "",
|
8607
|
+
"description": "To learn more about markets, refer to [the Shopify Markets conceptual\noverview](/docs/apps/markets).",
|
8608
|
+
"properties": [
|
8609
|
+
{
|
8610
|
+
"deprecated": false,
|
8611
|
+
"deprecation_reason": "",
|
8612
|
+
"description": "",
|
8613
|
+
"examples": [
|
8614
|
+
|
8615
|
+
],
|
8616
|
+
"return_type": [
|
8617
|
+
{
|
8618
|
+
"type": "string",
|
8619
|
+
"name": "",
|
8620
|
+
"description": "",
|
8621
|
+
"array_value": ""
|
8622
|
+
}
|
8623
|
+
],
|
8624
|
+
"summary": "The ID of the market.",
|
8625
|
+
"name": "id"
|
8626
|
+
},
|
8627
|
+
{
|
8628
|
+
"deprecated": false,
|
8629
|
+
"deprecation_reason": "",
|
8630
|
+
"description": "",
|
8631
|
+
"examples": [
|
8632
|
+
|
8633
|
+
],
|
8634
|
+
"return_type": [
|
8635
|
+
{
|
8636
|
+
"type": "string",
|
8637
|
+
"name": "",
|
8638
|
+
"description": "",
|
8639
|
+
"array_value": ""
|
8640
|
+
}
|
8641
|
+
],
|
8642
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the market.",
|
8643
|
+
"name": "handle"
|
8644
|
+
},
|
8645
|
+
{
|
8646
|
+
"deprecated": false,
|
8647
|
+
"deprecation_reason": "",
|
8648
|
+
"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).",
|
8649
|
+
"examples": [
|
8650
|
+
|
8651
|
+
],
|
8652
|
+
"return_type": [
|
8653
|
+
{
|
8654
|
+
"type": "array",
|
8655
|
+
"name": "",
|
8656
|
+
"description": "",
|
8657
|
+
"array_value": "metafield"
|
8658
|
+
}
|
8659
|
+
],
|
8660
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the market.",
|
8661
|
+
"name": "metafields"
|
8662
|
+
}
|
8663
|
+
],
|
8664
|
+
"summary": "A group of one or more regions of the world that a merchant is targeting for sales.",
|
8665
|
+
"name": "market",
|
8666
|
+
"examples": [
|
8667
|
+
|
8668
|
+
],
|
8669
|
+
"json_data": {
|
8670
|
+
"path": "/",
|
8671
|
+
"handle": "localization.market",
|
8672
|
+
"data_from_file": ""
|
8673
|
+
},
|
8674
|
+
"return_type": [
|
8675
|
+
|
8676
|
+
]
|
8677
|
+
},
|
8488
8678
|
{
|
8489
8679
|
"access": {
|
8490
8680
|
"global": false,
|
@@ -8638,12 +8828,12 @@
|
|
8638
8828
|
},
|
8639
8829
|
"deprecated": false,
|
8640
8830
|
"deprecation_reason": "",
|
8641
|
-
"description": "To learn about how to access a metafield on a specific object, refer to [Access metafields](/api/liquid/objects/metafield#metafield-access-metafields).\n\nMetafields support [multiple data types](/apps/metafields/types), which determine the kind of information that's stored\nin the metafield. You can also output the metafield content in a type-specific format using\n[metafield filters](/api/liquid/filters/metafield-filters).\n\n> Note:\n> You can't create metafields in Liquid. Metafields can be created in only the following ways:\n>\n> - [In the Shopify admin](https://help.shopify.com/manual/metafields)\n> - [Through an app](https://shopify.dev/apps/metafields)\n\n> Note:\n> Metafields of type `integer`, `json_string`, and `string` are older implementations that don't have the properties\n noted on this page, and aren't compatible with metafield filters. To learn more, refer to [Deprecated metafields](/api/liquid/objects/metafield#metafield-deprecated-metafields).",
|
8831
|
+
"description": "To learn about how to access a metafield on a specific object, refer to [Access metafields](/docs/api/liquid/objects/metafield#metafield-access-metafields).\n\nMetafields support [multiple data types](/apps/metafields/types), which determine the kind of information that's stored\nin the metafield. You can also output the metafield content in a type-specific format using\n[metafield filters](/docs/api/liquid/filters/metafield-filters).\n\n> Note:\n> You can't create metafields in Liquid. Metafields can be created in only the following ways:\n>\n> - [In the Shopify admin](https://help.shopify.com/manual/metafields)\n> - [Through an app](https://shopify.dev/apps/metafields)\n\n> Note:\n> Metafields of type `integer`, `json_string`, and `string` are older implementations that don't have the properties\n noted on this page, and aren't compatible with metafield filters. To learn more, refer to [Deprecated metafields](/docs/api/liquid/objects/metafield#metafield-deprecated-metafields).",
|
8642
8832
|
"properties": [
|
8643
8833
|
{
|
8644
8834
|
"deprecated": false,
|
8645
8835
|
"deprecation_reason": "",
|
8646
|
-
"description": "The following table outlines the value format for each metafield type:\n\n<table>\n <thead>\n <tr>\n <th>Type</th>\n <th>Returned format</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <code>single_line_text_field</code><br><br>\n <code>multi_line_text_field</code>\n </td>\n <td><a href=\"/api/liquid/basics#string\">A string</a></td>\n </tr>\n <tr>\n <td>\n <code>product_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/product\">A product object</a></td>\n </tr>\n <tr>\n <td>\n <code>collection_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/collection\">A collection object</a></td>\n </tr>\n <tr>\n <td>\n <code>variant_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/variant\">A variant object</a></td>\n </tr>\n <tr>\n <td>\n <code>page_reference</code>\n </td>\n <td><a href=\"/api/liquid/objects/page\">A page object</a></td>\n </tr>\n <tr>\n <td>\n <code>file_reference</code>\n </td>\n <td>\n <a href=\"/api/liquid/objects/generic-file\">A generic_file object</a><br><br>\n <a href=\"/api/liquid/objects/media\">A media object (images and videos only)</a>\n </td>\n </tr>\n <tr>\n <td>\n <code>number_integer</code><br><br>\n <code>number_decimal</code>\n </td>\n <td><a href=\"/api/liquid/basics#number\">A number</a></td>\n </tr>\n <tr>\n <td>\n <code>date</code><br><br>\n <code>date_time</code>\n </td>\n <td>A date string. To format the string, use the <a href=\"/api/liquid/filters/date\">date</a> filter.</td>\n </tr>\n <tr>\n <td>\n <code>url_reference</code>\n </td>\n <td><a href=\"/api/liquid/basics#string\">A url string</a></td>\n </tr>\n <tr>\n <td>\n <code>json</code>\n </td>\n <td><a href=\"https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON\">A JSON object</a></td>\n </tr>\n <tr>\n <td>\n <code>boolean</code>\n </td>\n <td><a href=\"/api/liquid/basics#boolean\">A boolean</a></td>\n <tr>\n <td>\n <code>color</code>\n </td>\n <td><a href=\"/api/liquid/objects/color\">A color object</a></td>\n </tr>\n <tr>\n <td>\n <code>weight</code><br><br>\n <code>volume</code><br><br>\n <code>dimension</code>\n </td>\n <td><a href=\"/api/liquid/objects/measurement\">A measurement object</a></td>\n </tr>\n <tr>\n <td>\n <code>rating</code>\n </td>\n <td><a href=\"/api/liquid/objects/rating\">A rating object</a></td>\n </tr>\n <tr>\n <td>\n <code>list</code>\n </td>\n <td><a href=\"/api/liquid/basics#array\">An array of objects, numbers, or strings, depending on the list type</a></td>\n </tr>\n <tr>\n <td>\n <code>money</code>\n </td>\n <td><a href=\"/api/liquid/objects/money\">A money object, displayed in the customer's local (presentment) currency.</a></td>\n </tr>\n </tbody>\n</table>",
|
8836
|
+
"description": "The following table outlines the value format for each metafield type:\n\n<table>\n <thead>\n <tr>\n <th>Type</th>\n <th>Returned format</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <code>single_line_text_field</code><br><br>\n <code>multi_line_text_field</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#string\">A string</a></td>\n </tr>\n <tr>\n <td>\n <code>product_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/product\">A product object</a></td>\n </tr>\n <tr>\n <td>\n <code>collection_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/collection\">A collection object</a></td>\n </tr>\n <tr>\n <td>\n <code>variant_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/variant\">A variant object</a></td>\n </tr>\n <tr>\n <td>\n <code>page_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/page\">A page object</a></td>\n </tr>\n <tr>\n <td>\n <code>file_reference</code>\n </td>\n <td>\n <a href=\"/docs/api/liquid/objects/generic-file\">A generic_file object</a><br><br>\n <a href=\"/docs/api/liquid/objects/media\">A media object (images and videos only)</a>\n </td>\n </tr>\n <tr>\n <td>\n <code>number_integer</code><br><br>\n <code>number_decimal</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#number\">A number</a></td>\n </tr>\n <tr>\n <td>\n <code>date</code><br><br>\n <code>date_time</code>\n </td>\n <td>A date string. To format the string, use the <a href=\"/docs/api/liquid/filters/date\">date</a> filter.</td>\n </tr>\n <tr>\n <td>\n <code>url_reference</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#string\">A url string</a></td>\n </tr>\n <tr>\n <td>\n <code>json</code>\n </td>\n <td><a href=\"https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON\">A JSON object</a></td>\n </tr>\n <tr>\n <td>\n <code>boolean</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#boolean\">A boolean</a></td>\n <tr>\n <td>\n <code>color</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/color\">A color object</a></td>\n </tr>\n <tr>\n <td>\n <code>weight</code><br><br>\n <code>volume</code><br><br>\n <code>dimension</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/measurement\">A measurement object</a></td>\n </tr>\n <tr>\n <td>\n <code>rating</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/rating\">A rating object</a></td>\n </tr>\n <tr>\n <td>\n <code>list</code>\n </td>\n <td><a href=\"/docs/api/liquid/basics#array\">An array of objects, numbers, or strings, depending on the list type</a></td>\n </tr>\n <tr>\n <td>\n <code>money</code>\n </td>\n <td><a href=\"/docs/api/liquid/objects/money\">A money object, displayed in the customer's local (presentment) currency.</a></td>\n </tr>\n </tbody>\n</table>",
|
8647
8837
|
"examples": [
|
8648
8838
|
|
8649
8839
|
],
|
@@ -8788,90 +8978,318 @@
|
|
8788
8978
|
},
|
8789
8979
|
{
|
8790
8980
|
"type": "string",
|
8791
|
-
"name": "money",
|
8981
|
+
"name": "money",
|
8982
|
+
"description": "",
|
8983
|
+
"array_value": ""
|
8984
|
+
}
|
8985
|
+
],
|
8986
|
+
"summary": "The [type](/apps/metafields/types) of the metafield.",
|
8987
|
+
"name": "type"
|
8988
|
+
},
|
8989
|
+
{
|
8990
|
+
"deprecated": false,
|
8991
|
+
"deprecation_reason": "",
|
8992
|
+
"description": "> Tip:\n> To learn about metafield types, refer to [Metafield types](/apps/metafields/types).",
|
8993
|
+
"examples": [
|
8994
|
+
|
8995
|
+
],
|
8996
|
+
"return_type": [
|
8997
|
+
{
|
8998
|
+
"type": "boolean",
|
8999
|
+
"name": "",
|
9000
|
+
"description": "",
|
9001
|
+
"array_value": ""
|
9002
|
+
}
|
9003
|
+
],
|
9004
|
+
"summary": "Returns `true` if the metafield is a list type. Returns `false` if not.",
|
9005
|
+
"name": "list?"
|
9006
|
+
}
|
9007
|
+
],
|
9008
|
+
"summary": "A [metafield](/apps/metafields) attached to a parent object.",
|
9009
|
+
"name": "metafield",
|
9010
|
+
"examples": [
|
9011
|
+
{
|
9012
|
+
"name": "Access metafields",
|
9013
|
+
"description": "The access path for metafields consists of two layers:\n\n- namespace - A grouping of metafields to prevent conflicts.\n- key - The metafield name.\n\nGiven this, you can access the metafield object with the following syntax:\n\n```liquid\n{{ resource.metafields.namespace.key }}\n```\n",
|
9014
|
+
"syntax": "",
|
9015
|
+
"path": "/products/health-potion",
|
9016
|
+
"raw_liquid": "Type: {{ product.metafields.information.directions.type }}\nValue: {{ product.metafields.information.directions.value }}",
|
9017
|
+
"parameter": false,
|
9018
|
+
"display_type": "text",
|
9019
|
+
"show_data_tab": false
|
9020
|
+
},
|
9021
|
+
{
|
9022
|
+
"name": "Accessing metafields of type `json`",
|
9023
|
+
"description": "The `value` property of metafields of type `json` returns a [JSON object](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON). You can access the properties of this object directly in Liquid, either by name or 0-based index. You can also iterate through the properties.\n",
|
9024
|
+
"syntax": "",
|
9025
|
+
"path": "/products/charcoal",
|
9026
|
+
"raw_liquid": "Temperature: {{ product.metafields.information.burn_temperature.value.temperature }}\nUnit: {{ product.metafields.information.burn_temperature.value['unit'] }}\n\n{% for property in product.metafields.information.burn_temperature.value -%}\n {{ property.first | capitalize }}: {{ property.last }}\n{%- endfor %}",
|
9027
|
+
"parameter": false,
|
9028
|
+
"display_type": "text",
|
9029
|
+
"show_data_tab": false
|
9030
|
+
},
|
9031
|
+
{
|
9032
|
+
"name": "Accessing metafields of type `list`",
|
9033
|
+
"description": "The `value` property of metafields of type `list` returns an array. You can iterate through the array to access the values.\n",
|
9034
|
+
"syntax": "",
|
9035
|
+
"path": "/products/ground-mandrake-root",
|
9036
|
+
"raw_liquid": "{% for item in product.metafields.information.combine_with.value -%}\n {{ item.product.title }}\n{%- endfor %}",
|
9037
|
+
"parameter": false,
|
9038
|
+
"display_type": "text",
|
9039
|
+
"show_data_tab": true
|
9040
|
+
},
|
9041
|
+
{
|
9042
|
+
"name": "",
|
9043
|
+
"description": "<br><br> If the list is of type `single_line_text_field`, then you can access the items in the array directly in Liquid by using a 0-based index.\n",
|
9044
|
+
"syntax": "",
|
9045
|
+
"path": "/products/health-potion",
|
9046
|
+
"raw_liquid": "First item in list: {{ product.metafields.information.pickup_locations.value[0] }}\nLast item in list: {{ product.metafields.information.pickup_locations.value.last }}",
|
9047
|
+
"parameter": false,
|
9048
|
+
"display_type": "text",
|
9049
|
+
"show_data_tab": true
|
9050
|
+
},
|
9051
|
+
{
|
9052
|
+
"name": "Deprecated metafields",
|
9053
|
+
"description": "Deprecated metafields are older metafield types with limited functionality. The following metafield types are deprecated:\n\n- `integer`\n- `json_string`\n- `string`\n\nThese metafield types don't have the same metafield object properties mentioned in the previous sections. Instead, they return the metafield value directly.\n\nThe following table outlines the value type for each deprecated metafield type:\n\n| Metafield type | Value type |\n| --- | --- |\n| `integer` | [An integer](/docs/api/liquid/basics#number) |\n| `json_string` | [A JSON object](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON) |\n| `string` | [A string](/docs/api/liquid/basics#string) |\n",
|
9054
|
+
"syntax": "",
|
9055
|
+
"path": "/",
|
9056
|
+
"raw_liquid": "",
|
9057
|
+
"parameter": false,
|
9058
|
+
"display_type": "text",
|
9059
|
+
"show_data_tab": true
|
9060
|
+
}
|
9061
|
+
],
|
9062
|
+
"json_data": {
|
9063
|
+
"path": "/products/health-potion",
|
9064
|
+
"handle": "product.metafields.information.directions",
|
9065
|
+
"data_from_file": ""
|
9066
|
+
},
|
9067
|
+
"return_type": [
|
9068
|
+
|
9069
|
+
]
|
9070
|
+
},
|
9071
|
+
{
|
9072
|
+
"access": {
|
9073
|
+
"global": false,
|
9074
|
+
"parents": [
|
9075
|
+
|
9076
|
+
],
|
9077
|
+
"template": [
|
9078
|
+
|
9079
|
+
]
|
9080
|
+
},
|
9081
|
+
"deprecated": false,
|
9082
|
+
"deprecation_reason": "",
|
9083
|
+
"description": "One or more corresponding [`metaobject`](/docs/api/liquid/objects#metaobject) objects contain values for\nthe fields specified in the metaobject definition.",
|
9084
|
+
"properties": [
|
9085
|
+
{
|
9086
|
+
"deprecated": false,
|
9087
|
+
"deprecation_reason": "",
|
9088
|
+
"description": "",
|
9089
|
+
"examples": [
|
9090
|
+
|
9091
|
+
],
|
9092
|
+
"return_type": [
|
9093
|
+
{
|
9094
|
+
"type": "array",
|
9095
|
+
"name": "",
|
9096
|
+
"description": "",
|
9097
|
+
"array_value": "metaobject"
|
9098
|
+
}
|
9099
|
+
],
|
9100
|
+
"summary": "The [metaobjects](/docs/api/liquid/objects#metaobject) that follow the definition.",
|
9101
|
+
"name": "values"
|
9102
|
+
},
|
9103
|
+
{
|
9104
|
+
"deprecated": false,
|
9105
|
+
"deprecation_reason": "",
|
9106
|
+
"description": "",
|
9107
|
+
"examples": [
|
9108
|
+
|
9109
|
+
],
|
9110
|
+
"return_type": [
|
9111
|
+
{
|
9112
|
+
"type": "number",
|
9113
|
+
"name": "",
|
9114
|
+
"description": "",
|
9115
|
+
"array_value": ""
|
9116
|
+
}
|
9117
|
+
],
|
9118
|
+
"summary": "The total number of entries for the metaobject definition.",
|
9119
|
+
"name": "values_count"
|
9120
|
+
}
|
9121
|
+
],
|
9122
|
+
"summary": "A `metaobject_definition` defines the structure of a metaobject type for the store, which consists of\na merchant-defined set of [field definitions](https://help.shopify.com/en/manual/metafields/metafield-definitions).",
|
9123
|
+
"name": "metaobject_definition",
|
9124
|
+
"examples": [
|
9125
|
+
{
|
9126
|
+
"name": "Loop over entries of a metaobject definition",
|
9127
|
+
"description": "If a metaobject definition has multiple metaobject entries, then you can loop over them using the `values` property.\nFor example, you can display the field `author` for each metaobject using the following `forloop`:\n\n```liquid\n{% for testimonial in shop.metaobjects.testimonials.values %}\n {{ testimonial.author.value }}\n{% endfor %}\n```\n\n> Note:\n> When the [`publishable` capability](/apps/data-extensions/metaobjects/capabilities) is enabled, loops return only metaobjects with a status of `active`. Metaobjects with a status of `draft` are skipped.\n",
|
9128
|
+
"syntax": "",
|
9129
|
+
"path": "",
|
9130
|
+
"raw_liquid": "",
|
9131
|
+
"parameter": false,
|
9132
|
+
"display_type": "text",
|
9133
|
+
"show_data_tab": false
|
9134
|
+
}
|
9135
|
+
],
|
9136
|
+
"json_data": {
|
9137
|
+
"path": "",
|
9138
|
+
"handle": "",
|
9139
|
+
"data_from_file": ""
|
9140
|
+
},
|
9141
|
+
"return_type": [
|
9142
|
+
|
9143
|
+
]
|
9144
|
+
},
|
9145
|
+
{
|
9146
|
+
"access": {
|
9147
|
+
"global": false,
|
9148
|
+
"parents": [
|
9149
|
+
{
|
9150
|
+
"object": "shop",
|
9151
|
+
"property": "metaobjects"
|
9152
|
+
}
|
9153
|
+
],
|
9154
|
+
"template": [
|
9155
|
+
|
9156
|
+
]
|
9157
|
+
},
|
9158
|
+
"deprecated": false,
|
9159
|
+
"deprecation_reason": "",
|
9160
|
+
"description": "",
|
9161
|
+
"properties": [
|
9162
|
+
{
|
9163
|
+
"deprecated": false,
|
9164
|
+
"deprecation_reason": "",
|
9165
|
+
"description": "",
|
9166
|
+
"examples": [
|
9167
|
+
|
9168
|
+
],
|
9169
|
+
"return_type": [
|
9170
|
+
{
|
9171
|
+
"type": "metaobject_system",
|
9172
|
+
"name": "",
|
9173
|
+
"description": "",
|
9174
|
+
"array_value": ""
|
9175
|
+
}
|
9176
|
+
],
|
9177
|
+
"summary": "Basic information about the metaobject. These properties are grouped under the `system` object to avoid collisions between system property names and user-defined metaobject fields.",
|
9178
|
+
"name": "system"
|
9179
|
+
}
|
9180
|
+
],
|
9181
|
+
"summary": "A metaobject entry, which includes the values for a set of [fields](/docs/api/liquid/objects#metafield).\nThe set is defined by the parent [`metaobject_definition`](/docs/api/liquid/objects#metaobject_definition).",
|
9182
|
+
"name": "metaobject",
|
9183
|
+
"examples": [
|
9184
|
+
{
|
9185
|
+
"name": "Access metaobjects individually",
|
9186
|
+
"description": "The access path for a metaobject consists of two layers:\n\n- type - The type of the parent metaobject definition.\n- handle - The unique [handle](/docs/api/liquid/basics#handles) of the metaobject.\n\nGiven this, you can access a metaobject with the following syntax:\n\n```liquid\n{{ shop.metaobjects.type.handle }}\n```\n\nYou can also use square bracket notation:\n\n```liquid\n{{ shop.metaobjects['type']['handle'] }}\n```\n\nA metaobjects's field values can be accessed using the key of the desired field:\n\n```liquid\n{{ shop.metaobjects.testimonials.homepage.title }}\n{{ shop.metaobjects['highlights']['washable'].image.value }}\n```\n\n> Note:\n> When the [`publishable` capability](/apps/data-extensions/metaobjects/capabilities) is enabled, a metaobject can only be accessed if its status is `active`. If its status is `draft`, then the return value is `nil`.\n",
|
9187
|
+
"syntax": "",
|
9188
|
+
"path": "",
|
9189
|
+
"raw_liquid": "",
|
9190
|
+
"parameter": false,
|
9191
|
+
"display_type": "text",
|
9192
|
+
"show_data_tab": false
|
9193
|
+
}
|
9194
|
+
],
|
9195
|
+
"json_data": {
|
9196
|
+
"path": "",
|
9197
|
+
"handle": "",
|
9198
|
+
"data_from_file": ""
|
9199
|
+
},
|
9200
|
+
"return_type": [
|
9201
|
+
|
9202
|
+
]
|
9203
|
+
},
|
9204
|
+
{
|
9205
|
+
"access": {
|
9206
|
+
"global": false,
|
9207
|
+
"parents": [
|
9208
|
+
{
|
9209
|
+
"object": "metaobject",
|
9210
|
+
"property": "system"
|
9211
|
+
}
|
9212
|
+
],
|
9213
|
+
"template": [
|
9214
|
+
|
9215
|
+
]
|
9216
|
+
},
|
9217
|
+
"deprecated": false,
|
9218
|
+
"deprecation_reason": "",
|
9219
|
+
"description": "",
|
9220
|
+
"properties": [
|
9221
|
+
{
|
9222
|
+
"deprecated": false,
|
9223
|
+
"deprecation_reason": "",
|
9224
|
+
"description": "This is a free-form string that's defined when the metaobject definition is created.",
|
9225
|
+
"examples": [
|
9226
|
+
|
9227
|
+
],
|
9228
|
+
"return_type": [
|
9229
|
+
{
|
9230
|
+
"type": "string",
|
9231
|
+
"name": "",
|
9232
|
+
"description": "",
|
9233
|
+
"array_value": ""
|
9234
|
+
}
|
9235
|
+
],
|
9236
|
+
"summary": "The type of the metaobject definition.",
|
9237
|
+
"name": "type"
|
9238
|
+
},
|
9239
|
+
{
|
9240
|
+
"deprecated": false,
|
9241
|
+
"deprecation_reason": "",
|
9242
|
+
"description": "",
|
9243
|
+
"examples": [
|
9244
|
+
|
9245
|
+
],
|
9246
|
+
"return_type": [
|
9247
|
+
{
|
9248
|
+
"type": "string",
|
9249
|
+
"name": "",
|
8792
9250
|
"description": "",
|
8793
9251
|
"array_value": ""
|
8794
9252
|
}
|
8795
9253
|
],
|
8796
|
-
"summary": "The [
|
8797
|
-
"name": "
|
9254
|
+
"summary": "The unique [handle](/api/liquid/basics#handles) of the metaobject.",
|
9255
|
+
"name": "handle"
|
8798
9256
|
},
|
8799
9257
|
{
|
8800
9258
|
"deprecated": false,
|
8801
9259
|
"deprecation_reason": "",
|
8802
|
-
"description": "
|
9260
|
+
"description": "",
|
8803
9261
|
"examples": [
|
8804
9262
|
|
8805
9263
|
],
|
8806
9264
|
"return_type": [
|
8807
9265
|
{
|
8808
|
-
"type": "
|
9266
|
+
"type": "number",
|
8809
9267
|
"name": "",
|
8810
9268
|
"description": "",
|
8811
9269
|
"array_value": ""
|
8812
9270
|
}
|
8813
9271
|
],
|
8814
|
-
"summary": "
|
8815
|
-
"name": "
|
9272
|
+
"summary": "The ID of the metaobject.",
|
9273
|
+
"name": "id"
|
8816
9274
|
}
|
8817
9275
|
],
|
8818
|
-
"summary": "
|
8819
|
-
"name": "
|
9276
|
+
"summary": "Basic information about a [`metaobject`](/api/liquid/objects#metaobject). These properties are grouped under the `system` object to avoid collisions between system property names and user-defined metaobject fields.",
|
9277
|
+
"name": "metaobject_system",
|
8820
9278
|
"examples": [
|
8821
9279
|
{
|
8822
|
-
"name": "
|
8823
|
-
"description": "
|
8824
|
-
"syntax": "",
|
8825
|
-
"path": "/products/health-potion",
|
8826
|
-
"raw_liquid": "Type: {{ product.metafields.information.directions.type }}\nValue: {{ product.metafields.information.directions.value }}",
|
8827
|
-
"parameter": false,
|
8828
|
-
"display_type": "text",
|
8829
|
-
"show_data_tab": false
|
8830
|
-
},
|
8831
|
-
{
|
8832
|
-
"name": "Accessing metafields of type `json`",
|
8833
|
-
"description": "The `value` property of metafields of type `json` returns a [JSON object](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON). You can access the properties of this object directly in Liquid, either by name or 0-based index. You can also iterate through the properties.\n",
|
8834
|
-
"syntax": "",
|
8835
|
-
"path": "/products/charcoal",
|
8836
|
-
"raw_liquid": "Temperature: {{ product.metafields.information.burn_temperature.value.temperature }}\nUnit: {{ product.metafields.information.burn_temperature.value['unit'] }}\n\n{% for property in product.metafields.information.burn_temperature.value -%}\n {{ property.first | capitalize }}: {{ property.last }}\n{%- endfor %}",
|
8837
|
-
"parameter": false,
|
8838
|
-
"display_type": "text",
|
8839
|
-
"show_data_tab": false
|
8840
|
-
},
|
8841
|
-
{
|
8842
|
-
"name": "Accessing metafields of type `list`",
|
8843
|
-
"description": "The `value` property of metafields of type `list` returns an array. You can iterate through the array to access the values.\n",
|
8844
|
-
"syntax": "",
|
8845
|
-
"path": "/products/ground-mandrake-root",
|
8846
|
-
"raw_liquid": "{% for item in product.metafields.information.combine_with.value -%}\n {{ item.product.title }}\n{%- endfor %}",
|
8847
|
-
"parameter": false,
|
8848
|
-
"display_type": "text",
|
8849
|
-
"show_data_tab": true
|
8850
|
-
},
|
8851
|
-
{
|
8852
|
-
"name": "",
|
8853
|
-
"description": "<br><br> If the list is of type `single_line_text_field`, then you can access the items in the array directly in Liquid by using a 0-based index.\n",
|
8854
|
-
"syntax": "",
|
8855
|
-
"path": "/products/health-potion",
|
8856
|
-
"raw_liquid": "First item in list: {{ product.metafields.information.pickup_locations.value[0] }}\nLast item in list: {{ product.metafields.information.pickup_locations.value.last }}",
|
8857
|
-
"parameter": false,
|
8858
|
-
"display_type": "text",
|
8859
|
-
"show_data_tab": true
|
8860
|
-
},
|
8861
|
-
{
|
8862
|
-
"name": "Deprecated metafields",
|
8863
|
-
"description": "Deprecated metafields are older metafield types with limited functionality. The following metafield types are deprecated:\n\n- `integer`\n- `json_string`\n- `string`\n\nThese metafield types don't have the same metafield object properties mentioned in the previous sections. Instead, they return the metafield value directly.\n\nThe following table outlines the value type for each deprecated metafield type:\n\n| Metafield type | Value type |\n| --- | --- |\n| `integer` | [An integer](/api/liquid/basics#number) |\n| `json_string` | [A JSON object](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON) |\n| `string` | [A string](/api/liquid/basics#string) |\n",
|
9280
|
+
"name": "Using the `metaobject_system` object",
|
9281
|
+
"description": "You can access the `metaobject_system` object and its properties through the metaobject's `system` property. You can use the following syntax:\n\n```liquid\n{{ shop.metaobjects.testimonials[\"home_page\"].system.id }}\n```\n\nYou can also access `metaobject_system` properties when iterating over a list of metaobjects:\n\n```liquid\n{% for metaobject in product.metafields.custom.mixed_metaobject_list.value %}\n {% if metaobject.system.type == \"testimonial\" %}\n {% render 'testimonial' with metaobject as testimonial %}\n {% else %}\n {{ metaobject.system.handle }}\n {% endif %}\n{% endfor %}\n```\n",
|
8864
9282
|
"syntax": "",
|
8865
|
-
"path": "
|
9283
|
+
"path": "",
|
8866
9284
|
"raw_liquid": "",
|
8867
9285
|
"parameter": false,
|
8868
9286
|
"display_type": "text",
|
8869
|
-
"show_data_tab":
|
9287
|
+
"show_data_tab": false
|
8870
9288
|
}
|
8871
9289
|
],
|
8872
9290
|
"json_data": {
|
8873
|
-
"path": "
|
8874
|
-
"handle": "
|
9291
|
+
"path": "",
|
9292
|
+
"handle": "",
|
8875
9293
|
"data_from_file": ""
|
8876
9294
|
},
|
8877
9295
|
"return_type": [
|
@@ -8893,7 +9311,7 @@
|
|
8893
9311
|
},
|
8894
9312
|
"deprecated": false,
|
8895
9313
|
"deprecation_reason": "",
|
8896
|
-
"description": "> Tip:\n> Use the [`model_viewer_tag` filter](/api/liquid/filters/model_viewer_tag) to output a [Google model viewer component](https://modelviewer.dev)\n> for the model.",
|
9314
|
+
"description": "> Tip:\n> Use the [`model_viewer_tag` filter](/docs/api/liquid/filters/model_viewer_tag) to output a [Google model viewer component](https://modelviewer.dev)\n> for the model.",
|
8897
9315
|
"properties": [
|
8898
9316
|
{
|
8899
9317
|
"deprecated": false,
|
@@ -8956,7 +9374,7 @@
|
|
8956
9374
|
"examples": [
|
8957
9375
|
{
|
8958
9376
|
"name": "Filter for media of a specific type",
|
8959
|
-
"description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
9377
|
+
"description": "You can use the `media_type` property with the [`where` filter](/docs/api/liquid/filters/where) to filter the [`product.media` array](/docs/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
8960
9378
|
"syntax": "",
|
8961
9379
|
"path": "/products/potion-bottle",
|
8962
9380
|
"raw_liquid": "{% assign models = product.media | where: 'media_type', 'model' %}\n\n{% for model in models %}\n {{- model | model_viewer_tag }}\n{% endfor %}",
|
@@ -8991,7 +9409,7 @@
|
|
8991
9409
|
"array_value": ""
|
8992
9410
|
}
|
8993
9411
|
],
|
8994
|
-
"summary": "The position of the model in the [`product.media`](/api/liquid/objects/product#product-media) array.",
|
9412
|
+
"summary": "The position of the model in the [`product.media`](/docs/api/liquid/objects/product#product-media) array.",
|
8995
9413
|
"name": "position"
|
8996
9414
|
},
|
8997
9415
|
{
|
@@ -9128,7 +9546,7 @@
|
|
9128
9546
|
},
|
9129
9547
|
"deprecated": false,
|
9130
9548
|
"deprecation_reason": "",
|
9131
|
-
"description": "> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
9549
|
+
"description": "> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
9132
9550
|
"properties": [
|
9133
9551
|
{
|
9134
9552
|
"deprecated": false,
|
@@ -9199,7 +9617,7 @@
|
|
9199
9617
|
"properties": [
|
9200
9618
|
{
|
9201
9619
|
"deprecated": true,
|
9202
|
-
"deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `order.discounts` property has been replaced by [`order.discount_applications`](/api/liquid/objects/order#order-discount_applications).",
|
9620
|
+
"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).",
|
9203
9621
|
"description": "",
|
9204
9622
|
"examples": [
|
9205
9623
|
|
@@ -9299,7 +9717,7 @@
|
|
9299
9717
|
"array_value": ""
|
9300
9718
|
}
|
9301
9719
|
],
|
9302
|
-
"summary": "The localized version of the [cancellation reason](/api/liquid/objects/order#order-cancel_reason) for the order.",
|
9720
|
+
"summary": "The localized version of the [cancellation reason](/docs/api/liquid/objects/order#order-cancel_reason) for the order.",
|
9303
9721
|
"name": "cancel_reason_label"
|
9304
9722
|
},
|
9305
9723
|
{
|
@@ -9323,7 +9741,7 @@
|
|
9323
9741
|
{
|
9324
9742
|
"deprecated": false,
|
9325
9743
|
"deprecation_reason": "",
|
9326
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
9744
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
9327
9745
|
"examples": [
|
9328
9746
|
|
9329
9747
|
],
|
@@ -9359,7 +9777,7 @@
|
|
9359
9777
|
{
|
9360
9778
|
"deprecated": false,
|
9361
9779
|
"deprecation_reason": "",
|
9362
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
9780
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
9363
9781
|
"examples": [
|
9364
9782
|
|
9365
9783
|
],
|
@@ -9377,7 +9795,7 @@
|
|
9377
9795
|
{
|
9378
9796
|
"deprecated": false,
|
9379
9797
|
"deprecation_reason": "",
|
9380
|
-
"description": "If there are no duties, then `nil` is returned. The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
9798
|
+
"description": "If there are no duties, then `nil` is returned. The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
9381
9799
|
"examples": [
|
9382
9800
|
|
9383
9801
|
],
|
@@ -9449,7 +9867,7 @@
|
|
9449
9867
|
{
|
9450
9868
|
"deprecated": false,
|
9451
9869
|
"deprecation_reason": "",
|
9452
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
9870
|
+
"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.",
|
9453
9871
|
"examples": [
|
9454
9872
|
|
9455
9873
|
],
|
@@ -9467,7 +9885,7 @@
|
|
9467
9885
|
{
|
9468
9886
|
"deprecated": false,
|
9469
9887
|
"deprecation_reason": "",
|
9470
|
-
"description": "The amount is calculated after refunds are applied, so is equal to `order.total_price` minus `order.total_refunded_amount`.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
9888
|
+
"description": "The amount is calculated after refunds are applied, so is equal to `order.total_price` minus `order.total_refunded_amount`.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
9471
9889
|
"examples": [
|
9472
9890
|
|
9473
9891
|
],
|
@@ -9485,7 +9903,7 @@
|
|
9485
9903
|
{
|
9486
9904
|
"deprecated": false,
|
9487
9905
|
"deprecation_reason": "",
|
9488
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
9906
|
+
"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.",
|
9489
9907
|
"examples": [
|
9490
9908
|
|
9491
9909
|
],
|
@@ -9503,7 +9921,7 @@
|
|
9503
9921
|
{
|
9504
9922
|
"deprecated": false,
|
9505
9923
|
"deprecation_reason": "",
|
9506
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
9924
|
+
"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.",
|
9507
9925
|
"examples": [
|
9508
9926
|
|
9509
9927
|
],
|
@@ -9612,7 +10030,7 @@
|
|
9612
10030
|
"return_type": [
|
9613
10031
|
|
9614
10032
|
],
|
9615
|
-
"summary": "The localized version of the [financial status](/api/liquid/objects/order#order-financial_status) of the order.",
|
10033
|
+
"summary": "The localized version of the [financial status](/docs/api/liquid/objects/order#order-financial_status) of the order.",
|
9616
10034
|
"name": "financial_status_label"
|
9617
10035
|
},
|
9618
10036
|
{
|
@@ -9672,7 +10090,7 @@
|
|
9672
10090
|
"array_value": ""
|
9673
10091
|
}
|
9674
10092
|
],
|
9675
|
-
"summary": "The localized version of the [fulfillment status](/api/liquid/objects/order#order-fulfillment_status) of the order.",
|
10093
|
+
"summary": "The localized version of the [fulfillment status](/docs/api/liquid/objects/order#order-fulfillment_status) of the order.",
|
9676
10094
|
"name": "fulfillment_status_label"
|
9677
10095
|
},
|
9678
10096
|
{
|
@@ -9708,7 +10126,7 @@
|
|
9708
10126
|
"array_value": ""
|
9709
10127
|
}
|
9710
10128
|
],
|
9711
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the order.",
|
10129
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the order.",
|
9712
10130
|
"name": "metafields"
|
9713
10131
|
},
|
9714
10132
|
{
|
@@ -9762,7 +10180,7 @@
|
|
9762
10180
|
"array_value": ""
|
9763
10181
|
}
|
9764
10182
|
],
|
9765
|
-
"summary": "The integer representation of the order [name](/api/liquid/objects/order#order-name).",
|
10183
|
+
"summary": "The integer representation of the order [name](/docs/api/liquid/objects/order#order-name).",
|
9766
10184
|
"name": "order_number"
|
9767
10185
|
},
|
9768
10186
|
{
|
@@ -9930,7 +10348,7 @@
|
|
9930
10348
|
{
|
9931
10349
|
"deprecated": false,
|
9932
10350
|
"deprecation_reason": "",
|
9933
|
-
"description": "> Note:\n> These line items are used to calculate the the [subtotal price](/api/liquid/objects/order#order-subtotal_price).",
|
10351
|
+
"description": "> Note:\n> These line items are used to calculate the the [subtotal price](/docs/api/liquid/objects/order#order-subtotal_price).",
|
9934
10352
|
"examples": [
|
9935
10353
|
|
9936
10354
|
],
|
@@ -9984,7 +10402,7 @@
|
|
9984
10402
|
{
|
9985
10403
|
"deprecated": false,
|
9986
10404
|
"deprecation_reason": "",
|
9987
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
10405
|
+
"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.",
|
9988
10406
|
"examples": [
|
9989
10407
|
|
9990
10408
|
],
|
@@ -10002,7 +10420,7 @@
|
|
10002
10420
|
{
|
10003
10421
|
"deprecated": false,
|
10004
10422
|
"deprecation_reason": "",
|
10005
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
10423
|
+
"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.",
|
10006
10424
|
"examples": [
|
10007
10425
|
|
10008
10426
|
],
|
@@ -10014,13 +10432,13 @@
|
|
10014
10432
|
"array_value": ""
|
10015
10433
|
}
|
10016
10434
|
],
|
10017
|
-
"summary": "The sum of the prices of the [subtotal line items](/api/liquid/objects/order#order-subtotal_line_items) in the currency's subunit, after any line item or\ncart discounts have been applied.",
|
10435
|
+
"summary": "The sum of the prices of the [subtotal line items](/docs/api/liquid/objects/order#order-subtotal_line_items) in the currency's subunit, after any line item or\ncart discounts have been applied.",
|
10018
10436
|
"name": "subtotal_price"
|
10019
10437
|
},
|
10020
10438
|
{
|
10021
10439
|
"deprecated": false,
|
10022
10440
|
"deprecation_reason": "",
|
10023
|
-
"description": "> Note:\n> The total price is calculated before refunds are applied. Use [`order.total_net_amount`](/api/liquid/objects/order#order-total_net_amount)\n> to output the total minus any refunds.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
10441
|
+
"description": "> Note:\n> The total price is calculated before refunds are applied. Use [`order.total_net_amount`](/docs/api/liquid/objects/order#order-total_net_amount)\n> to output the total minus any refunds.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
10024
10442
|
"examples": [
|
10025
10443
|
|
10026
10444
|
],
|
@@ -10038,7 +10456,7 @@
|
|
10038
10456
|
{
|
10039
10457
|
"deprecated": false,
|
10040
10458
|
"deprecation_reason": "",
|
10041
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
10459
|
+
"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.",
|
10042
10460
|
"examples": [
|
10043
10461
|
|
10044
10462
|
],
|
@@ -10140,7 +10558,7 @@
|
|
10140
10558
|
"array_value": ""
|
10141
10559
|
}
|
10142
10560
|
],
|
10143
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the page.",
|
10561
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the page.",
|
10144
10562
|
"name": "handle"
|
10145
10563
|
},
|
10146
10564
|
{
|
@@ -10230,13 +10648,13 @@
|
|
10230
10648
|
"array_value": ""
|
10231
10649
|
}
|
10232
10650
|
],
|
10233
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the page.",
|
10651
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the page.",
|
10234
10652
|
"name": "metafields"
|
10235
10653
|
},
|
10236
10654
|
{
|
10237
10655
|
"deprecated": false,
|
10238
10656
|
"deprecation_reason": "",
|
10239
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
10657
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
10240
10658
|
"examples": [
|
10241
10659
|
|
10242
10660
|
],
|
@@ -10278,7 +10696,7 @@
|
|
10278
10696
|
},
|
10279
10697
|
"deprecated": false,
|
10280
10698
|
"deprecation_reason": "",
|
10281
|
-
"description": "> Tip:\n> Use the [`default_pagination` filter](/api/liquid/filters/default_pagination) to output pagination links.",
|
10699
|
+
"description": "> Tip:\n> Use the [`default_pagination` filter](/docs/api/liquid/filters/default_pagination) to output pagination links.",
|
10282
10700
|
"properties": [
|
10283
10701
|
{
|
10284
10702
|
"deprecated": false,
|
@@ -10443,7 +10861,7 @@
|
|
10443
10861
|
"name": "page_param"
|
10444
10862
|
}
|
10445
10863
|
],
|
10446
|
-
"summary": "Information about the pagination inside a set of [`paginate` tags](/api/liquid/tags/paginate).",
|
10864
|
+
"summary": "Information about the pagination inside a set of [`paginate` tags](/docs/api/liquid/tags/paginate).",
|
10447
10865
|
"name": "paginate",
|
10448
10866
|
"examples": [
|
10449
10867
|
|
@@ -10492,7 +10910,7 @@
|
|
10492
10910
|
{
|
10493
10911
|
"deprecated": false,
|
10494
10912
|
"deprecation_reason": "",
|
10495
|
-
"description": "You can check whether any resources of a specific type were returned using the [`size` filter](/api/liquid/filters/size).\n\n```liquid\n{% if predictive_search.resources.articles.size > 0 %}\n {% for article in predictive_search.resources.articles %}\n {{ article.title }}\n {% endfor %}\n{% endif %}\n```",
|
10913
|
+
"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```",
|
10496
10914
|
"examples": [
|
10497
10915
|
|
10498
10916
|
],
|
@@ -10510,7 +10928,7 @@
|
|
10510
10928
|
{
|
10511
10929
|
"deprecated": false,
|
10512
10930
|
"deprecation_reason": "",
|
10513
|
-
"description": "> Tip:\n> Use the [`highlight` filter](/api/liquid/filters/highlight) to highlight the search terms in search results content.",
|
10931
|
+
"description": "> Tip:\n> Use the [`highlight` filter](/docs/api/liquid/filters/highlight) to highlight the search terms in search results content.",
|
10514
10932
|
"examples": [
|
10515
10933
|
|
10516
10934
|
],
|
@@ -10528,7 +10946,7 @@
|
|
10528
10946
|
{
|
10529
10947
|
"deprecated": false,
|
10530
10948
|
"deprecation_reason": "",
|
10531
|
-
"description": "Searches can be performed on the following object types:\n\n- [`article`](/api/liquid/objects/article)\n- [`collection`](/api/liquid/objects/collection)\n- [`page`](/api/liquid/objects/page)\n- [`product`](/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the [`types` query parameter](/api/ajax/reference/predictive-search#query-parameters).",
|
10949
|
+
"description": "Searches can be performed on the following object types:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`collection`](/docs/api/liquid/objects/collection)\n- [`page`](/docs/api/liquid/objects/page)\n- [`product`](/docs/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the [`types` query parameter](/api/ajax/reference/predictive-search#query-parameters).",
|
10532
10950
|
"examples": [
|
10533
10951
|
|
10534
10952
|
],
|
@@ -10608,7 +11026,7 @@
|
|
10608
11026
|
"array_value": ""
|
10609
11027
|
}
|
10610
11028
|
],
|
10611
|
-
"summary": "The 1-based index of the price adjustment in the [`selling_plan.price_adjustments` array](/api/liquid/objects/selling_plan#selling_plan-price_adjustments).",
|
11029
|
+
"summary": "The 1-based index of the price adjustment in the [`selling_plan.price_adjustments` array](/docs/api/liquid/objects/selling_plan#selling_plan-price_adjustments).",
|
10612
11030
|
"name": "position"
|
10613
11031
|
},
|
10614
11032
|
{
|
@@ -10644,7 +11062,7 @@
|
|
10644
11062
|
{
|
10645
11063
|
"deprecated": false,
|
10646
11064
|
"deprecation_reason": "",
|
10647
|
-
"description": "How this value is interpreted depends on the [value type](/api/liquid/objects/selling_plan_price_adjustment#selling_plan_price_adjustment-value_type) of\nthe price adjustment. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount that the original price is being adjusted by, in the currency's subunit. |\n| `percentage` | The percent amount that the original price is being adjusted by. |\n| `price` | The adjusted amount in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
11065
|
+
"description": "How this value is interpreted depends on the [value type](/docs/api/liquid/objects/selling_plan_price_adjustment#selling_plan_price_adjustment-value_type) of\nthe price adjustment. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount that the original price is being adjusted by, in the currency's subunit. |\n| `percentage` | The percent amount that the original price is being adjusted by. |\n| `price` | The adjusted amount in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
10648
11066
|
"examples": [
|
10649
11067
|
|
10650
11068
|
],
|
@@ -10770,7 +11188,7 @@
|
|
10770
11188
|
"array_value": ""
|
10771
11189
|
}
|
10772
11190
|
],
|
10773
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the product.",
|
11191
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the product.",
|
10774
11192
|
"name": "metafields"
|
10775
11193
|
},
|
10776
11194
|
{
|
@@ -10842,7 +11260,7 @@
|
|
10842
11260
|
"array_value": ""
|
10843
11261
|
}
|
10844
11262
|
],
|
10845
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the product.",
|
11263
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the product.",
|
10846
11264
|
"name": "handle"
|
10847
11265
|
},
|
10848
11266
|
{
|
@@ -10884,7 +11302,7 @@
|
|
10884
11302
|
{
|
10885
11303
|
"deprecated": false,
|
10886
11304
|
"deprecation_reason": "",
|
10887
|
-
"description": "> Note:\n> This is the same value as [`product.content`](/api/liquid/objects/product#product-content).",
|
11305
|
+
"description": "> Note:\n> This is the same value as [`product.content`](/docs/api/liquid/objects/product#product-content).",
|
10888
11306
|
"examples": [
|
10889
11307
|
|
10890
11308
|
],
|
@@ -10902,7 +11320,7 @@
|
|
10902
11320
|
{
|
10903
11321
|
"deprecated": false,
|
10904
11322
|
"deprecation_reason": "",
|
10905
|
-
"description": "> Note:\n> This is the same value as [`product.description`](/api/liquid/objects/product#product-description).",
|
11323
|
+
"description": "> Note:\n> This is the same value as [`product.description`](/docs/api/liquid/objects/product#product-description).",
|
10906
11324
|
"examples": [
|
10907
11325
|
|
10908
11326
|
],
|
@@ -10938,7 +11356,7 @@
|
|
10938
11356
|
{
|
10939
11357
|
"deprecated": false,
|
10940
11358
|
"deprecation_reason": "",
|
10941
|
-
"description": "> Tip:\n> You can use [media filters](/api/liquid/filters/media-filters) to output media URLs and displays. To learn about how\n> to include media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).",
|
11359
|
+
"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).",
|
10942
11360
|
"examples": [
|
10943
11361
|
|
10944
11362
|
],
|
@@ -10956,7 +11374,7 @@
|
|
10956
11374
|
{
|
10957
11375
|
"deprecated": false,
|
10958
11376
|
"deprecation_reason": "",
|
10959
|
-
"description": "> Tip:\n> You can use [media filters](/api/liquid/filters/media-filters) to output media URLs and displays. To learn about how\n> to include media in your theme, refer to [Support product media](/themes/product-merchandising/media/support-media).",
|
11377
|
+
"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).",
|
10960
11378
|
"examples": [
|
10961
11379
|
|
10962
11380
|
],
|
@@ -10974,7 +11392,7 @@
|
|
10974
11392
|
{
|
10975
11393
|
"deprecated": false,
|
10976
11394
|
"deprecation_reason": "",
|
10977
|
-
"description": "> Note:\n> This is the same value as [`product.price`](/api/liquid/objects/product#product-price).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
11395
|
+
"description": "> Note:\n> This is the same value as [`product.price`](/docs/api/liquid/objects/product#product-price).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
10978
11396
|
"examples": [
|
10979
11397
|
|
10980
11398
|
],
|
@@ -10992,7 +11410,7 @@
|
|
10992
11410
|
{
|
10993
11411
|
"deprecated": false,
|
10994
11412
|
"deprecation_reason": "",
|
10995
|
-
"description": "> Note:\n> This is the same value as [`product.price_min`](/api/liquid/objects/product#product-price_min).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
11413
|
+
"description": "> Note:\n> This is the same value as [`product.price_min`](/docs/api/liquid/objects/product#product-price_min).\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
10996
11414
|
"examples": [
|
10997
11415
|
|
10998
11416
|
],
|
@@ -11010,7 +11428,7 @@
|
|
11010
11428
|
{
|
11011
11429
|
"deprecated": false,
|
11012
11430
|
"deprecation_reason": "",
|
11013
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
11431
|
+
"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.",
|
11014
11432
|
"examples": [
|
11015
11433
|
|
11016
11434
|
],
|
@@ -11046,7 +11464,7 @@
|
|
11046
11464
|
{
|
11047
11465
|
"deprecated": false,
|
11048
11466
|
"deprecation_reason": "",
|
11049
|
-
"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
|
11467
|
+
"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`.",
|
11050
11468
|
"examples": [
|
11051
11469
|
|
11052
11470
|
],
|
@@ -11100,7 +11518,7 @@
|
|
11100
11518
|
{
|
11101
11519
|
"deprecated": false,
|
11102
11520
|
"deprecation_reason": "",
|
11103
|
-
"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
|
11521
|
+
"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`.",
|
11104
11522
|
"examples": [
|
11105
11523
|
|
11106
11524
|
],
|
@@ -11118,7 +11536,7 @@
|
|
11118
11536
|
{
|
11119
11537
|
"deprecated": false,
|
11120
11538
|
"deprecation_reason": "",
|
11121
|
-
"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
|
11539
|
+
"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`.",
|
11122
11540
|
"examples": [
|
11123
11541
|
|
11124
11542
|
],
|
@@ -11140,7 +11558,7 @@
|
|
11140
11558
|
"examples": [
|
11141
11559
|
{
|
11142
11560
|
"name": "Output the options",
|
11143
|
-
"description": "You can use the [`size` filter](/api/liquid/filters/size) with dot notation to determine how many options a product has.\n",
|
11561
|
+
"description": "You can use the [`size` filter](/docs/api/liquid/filters/size) with dot notation to determine how many options a product has.\n",
|
11144
11562
|
"syntax": "",
|
11145
11563
|
"path": "/products/health-potion",
|
11146
11564
|
"raw_liquid": "{% if product.options.size > 0 -%}\n {% for option in product.options -%}\n - {{ option }}\n {%- endfor %}\n{%- endif %}",
|
@@ -11181,7 +11599,7 @@
|
|
11181
11599
|
{
|
11182
11600
|
"deprecated": false,
|
11183
11601
|
"deprecation_reason": "",
|
11184
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
11602
|
+
"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.",
|
11185
11603
|
"examples": [
|
11186
11604
|
|
11187
11605
|
],
|
@@ -11199,7 +11617,7 @@
|
|
11199
11617
|
{
|
11200
11618
|
"deprecated": false,
|
11201
11619
|
"deprecation_reason": "",
|
11202
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
11620
|
+
"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.",
|
11203
11621
|
"examples": [
|
11204
11622
|
|
11205
11623
|
],
|
@@ -11217,7 +11635,7 @@
|
|
11217
11635
|
{
|
11218
11636
|
"deprecated": false,
|
11219
11637
|
"deprecation_reason": "",
|
11220
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
11638
|
+
"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.",
|
11221
11639
|
"examples": [
|
11222
11640
|
|
11223
11641
|
],
|
@@ -11289,7 +11707,7 @@
|
|
11289
11707
|
{
|
11290
11708
|
"deprecated": false,
|
11291
11709
|
"deprecation_reason": "",
|
11292
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
11710
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
11293
11711
|
"examples": [
|
11294
11712
|
|
11295
11713
|
],
|
@@ -11307,7 +11725,7 @@
|
|
11307
11725
|
{
|
11308
11726
|
"deprecated": false,
|
11309
11727
|
"deprecation_reason": "",
|
11310
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
11728
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
11311
11729
|
"examples": [
|
11312
11730
|
|
11313
11731
|
],
|
@@ -11346,7 +11764,7 @@
|
|
11346
11764
|
"array_value": ""
|
11347
11765
|
}
|
11348
11766
|
],
|
11349
|
-
"summary": "Allows you to access a specific [product option](/api/liquid/objects/product_option) by its name.",
|
11767
|
+
"summary": "Allows you to access a specific [product option](/docs/api/liquid/objects/product_option) by its name.",
|
11350
11768
|
"name": "options_by_name"
|
11351
11769
|
},
|
11352
11770
|
{
|
@@ -11370,7 +11788,7 @@
|
|
11370
11788
|
{
|
11371
11789
|
"deprecated": false,
|
11372
11790
|
"deprecation_reason": "",
|
11373
|
-
"description": "> Note:\n> A variant requires a selling plan if [`variant.requires_selling_plan`](/api/liquid/objects/variant#variant-requires_selling_plan)\n> is `true`.",
|
11791
|
+
"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`.",
|
11374
11792
|
"examples": [
|
11375
11793
|
|
11376
11794
|
],
|
@@ -11540,7 +11958,7 @@
|
|
11540
11958
|
"array_value": ""
|
11541
11959
|
}
|
11542
11960
|
],
|
11543
|
-
"summary": "The 1-based index of the product option in the [`product.options_with_values` array](/api/liquid/objects/product#product-options_with_values).",
|
11961
|
+
"summary": "The 1-based index of the product option in the [`product.options_with_values` array](/docs/api/liquid/objects/product#product-options_with_values).",
|
11544
11962
|
"name": "position"
|
11545
11963
|
},
|
11546
11964
|
{
|
@@ -11642,7 +12060,7 @@
|
|
11642
12060
|
"array_value": ""
|
11643
12061
|
}
|
11644
12062
|
],
|
11645
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the variant.",
|
12063
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the variant.",
|
11646
12064
|
"name": "metafields"
|
11647
12065
|
},
|
11648
12066
|
{
|
@@ -11747,7 +12165,25 @@
|
|
11747
12165
|
{
|
11748
12166
|
"deprecated": false,
|
11749
12167
|
"deprecation_reason": "",
|
11750
|
-
"description": "
|
12168
|
+
"description": "> Note:\n> The default quantity rule is `min=1,max=null,increment=1`.",
|
12169
|
+
"examples": [
|
12170
|
+
|
12171
|
+
],
|
12172
|
+
"return_type": [
|
12173
|
+
{
|
12174
|
+
"type": "quantity_rule",
|
12175
|
+
"name": "",
|
12176
|
+
"description": "",
|
12177
|
+
"array_value": ""
|
12178
|
+
}
|
12179
|
+
],
|
12180
|
+
"summary": "Returns the specified quantity rule for the variant if one exists in the current customer context. Otherwise returns `min=1,max=nil,increment=1` if the variant does not have any quantity rule.",
|
12181
|
+
"name": "quantity_rule"
|
12182
|
+
},
|
12183
|
+
{
|
12184
|
+
"deprecated": false,
|
12185
|
+
"deprecation_reason": "",
|
12186
|
+
"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.",
|
11751
12187
|
"examples": [
|
11752
12188
|
|
11753
12189
|
],
|
@@ -11765,7 +12201,7 @@
|
|
11765
12201
|
{
|
11766
12202
|
"deprecated": false,
|
11767
12203
|
"deprecation_reason": "",
|
11768
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
12204
|
+
"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.",
|
11769
12205
|
"examples": [
|
11770
12206
|
|
11771
12207
|
],
|
@@ -11894,7 +12330,7 @@
|
|
11894
12330
|
"array_value": ""
|
11895
12331
|
}
|
11896
12332
|
],
|
11897
|
-
"summary": "The values of the variant for each [product option](/api/liquid/objects/product_option).",
|
12333
|
+
"summary": "The values of the variant for each [product option](/docs/api/liquid/objects/product_option).",
|
11898
12334
|
"name": "options"
|
11899
12335
|
},
|
11900
12336
|
{
|
@@ -11972,7 +12408,7 @@
|
|
11972
12408
|
{
|
11973
12409
|
"deprecated": false,
|
11974
12410
|
"deprecation_reason": "",
|
11975
|
-
"description": "> Tip:\n> To output the weight of a variant in this unit, use this property, and the `variant.weight_in_unit` property, with the\n> [`weight_with_unit` filter](/api/liquid/filters/weight_with_unit).",
|
12411
|
+
"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).",
|
11976
12412
|
"examples": [
|
11977
12413
|
|
11978
12414
|
],
|
@@ -11990,7 +12426,7 @@
|
|
11990
12426
|
{
|
11991
12427
|
"deprecated": false,
|
11992
12428
|
"deprecation_reason": "",
|
11993
|
-
"description": "> Tip:\n> To output this weight, use this property, and the `variant.weight_unit` property, with the [`weight_with_unit` filter](/api/liquid/filters/weight_with_unit).",
|
12429
|
+
"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).",
|
11994
12430
|
"examples": [
|
11995
12431
|
|
11996
12432
|
],
|
@@ -12008,7 +12444,7 @@
|
|
12008
12444
|
{
|
12009
12445
|
"deprecated": false,
|
12010
12446
|
"deprecation_reason": "",
|
12011
|
-
"description": "> Tip:\n> Use the [`weight_with_unit`
|
12447
|
+
"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.",
|
12012
12448
|
"examples": [
|
12013
12449
|
|
12014
12450
|
],
|
@@ -12044,7 +12480,7 @@
|
|
12044
12480
|
{
|
12045
12481
|
"deprecated": false,
|
12046
12482
|
"deprecation_reason": "",
|
12047
|
-
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
12483
|
+
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
12048
12484
|
"examples": [
|
12049
12485
|
|
12050
12486
|
],
|
@@ -12158,7 +12594,7 @@
|
|
12158
12594
|
{
|
12159
12595
|
"deprecated": false,
|
12160
12596
|
"deprecation_reason": "",
|
12161
|
-
"description": "> Note:\n> This is the same value as [`variant.image`](/api/liquid/objects/variant#variant-image).",
|
12597
|
+
"description": "> Note:\n> This is the same value as [`variant.image`](/docs/api/liquid/objects/variant#variant-image).",
|
12162
12598
|
"examples": [
|
12163
12599
|
|
12164
12600
|
],
|
@@ -12176,7 +12612,7 @@
|
|
12176
12612
|
{
|
12177
12613
|
"deprecated": false,
|
12178
12614
|
"deprecation_reason": "",
|
12179
|
-
"description": "> Note:\n> This is the same value as [`variant.featured_image`](/api/liquid/objects/variant#variant-featured_image).",
|
12615
|
+
"description": "> Note:\n> This is the same value as [`variant.featured_image`](/docs/api/liquid/objects/variant#variant-featured_image).",
|
12180
12616
|
"examples": [
|
12181
12617
|
|
12182
12618
|
],
|
@@ -12230,7 +12666,7 @@
|
|
12230
12666
|
{
|
12231
12667
|
"deprecated": false,
|
12232
12668
|
"deprecation_reason": "",
|
12233
|
-
"description": "Incoming inventory information is populated by [inventory transfers](https://help.shopify.com/manual/products/inventory/transfers).\n\n> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the date.",
|
12669
|
+
"description": "Incoming inventory information is populated by [inventory transfers](https://help.shopify.com/manual/products/inventory/transfers).\n\n> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the date.",
|
12234
12670
|
"examples": [
|
12235
12671
|
|
12236
12672
|
],
|
@@ -12382,6 +12818,92 @@
|
|
12382
12818
|
|
12383
12819
|
]
|
12384
12820
|
},
|
12821
|
+
{
|
12822
|
+
"access": {
|
12823
|
+
"global": false,
|
12824
|
+
"parents": [
|
12825
|
+
{
|
12826
|
+
"object": "gift_card",
|
12827
|
+
"property": "recipient"
|
12828
|
+
}
|
12829
|
+
],
|
12830
|
+
"template": [
|
12831
|
+
"gift_card.liquid"
|
12832
|
+
]
|
12833
|
+
},
|
12834
|
+
"deprecated": false,
|
12835
|
+
"deprecation_reason": "",
|
12836
|
+
"description": "",
|
12837
|
+
"properties": [
|
12838
|
+
{
|
12839
|
+
"deprecated": false,
|
12840
|
+
"deprecation_reason": "",
|
12841
|
+
"description": "",
|
12842
|
+
"examples": [
|
12843
|
+
|
12844
|
+
],
|
12845
|
+
"return_type": [
|
12846
|
+
{
|
12847
|
+
"type": "string",
|
12848
|
+
"name": "",
|
12849
|
+
"description": "",
|
12850
|
+
"array_value": ""
|
12851
|
+
}
|
12852
|
+
],
|
12853
|
+
"summary": "The nickname of the recipient.",
|
12854
|
+
"name": "nickname"
|
12855
|
+
},
|
12856
|
+
{
|
12857
|
+
"deprecated": false,
|
12858
|
+
"deprecation_reason": "",
|
12859
|
+
"description": "",
|
12860
|
+
"examples": [
|
12861
|
+
|
12862
|
+
],
|
12863
|
+
"return_type": [
|
12864
|
+
{
|
12865
|
+
"type": "string",
|
12866
|
+
"name": "",
|
12867
|
+
"description": "",
|
12868
|
+
"array_value": ""
|
12869
|
+
}
|
12870
|
+
],
|
12871
|
+
"summary": "The email of the recipient.",
|
12872
|
+
"name": "email"
|
12873
|
+
},
|
12874
|
+
{
|
12875
|
+
"deprecated": false,
|
12876
|
+
"deprecation_reason": "",
|
12877
|
+
"description": "",
|
12878
|
+
"examples": [
|
12879
|
+
|
12880
|
+
],
|
12881
|
+
"return_type": [
|
12882
|
+
{
|
12883
|
+
"type": "string",
|
12884
|
+
"name": "",
|
12885
|
+
"description": "",
|
12886
|
+
"array_value": ""
|
12887
|
+
}
|
12888
|
+
],
|
12889
|
+
"summary": "The full name of the recipient.",
|
12890
|
+
"name": "name"
|
12891
|
+
}
|
12892
|
+
],
|
12893
|
+
"summary": "A recipient that is associated with a [gift card](https://help.shopify.com/manual/products/gift-card-products).",
|
12894
|
+
"name": "recipient",
|
12895
|
+
"examples": [
|
12896
|
+
|
12897
|
+
],
|
12898
|
+
"json_data": {
|
12899
|
+
"path": "",
|
12900
|
+
"handle": "",
|
12901
|
+
"data_from_file": "{\"email\":\"cornelius.potionmaker@gmail.com\",\"name\":\"Cornelius Potionmaker\",\"nickname\":\"Cornelius\"}"
|
12902
|
+
},
|
12903
|
+
"return_type": [
|
12904
|
+
|
12905
|
+
]
|
12906
|
+
},
|
12385
12907
|
{
|
12386
12908
|
"access": {
|
12387
12909
|
"global": false,
|
@@ -12417,7 +12939,7 @@
|
|
12417
12939
|
{
|
12418
12940
|
"deprecated": false,
|
12419
12941
|
"deprecation_reason": "",
|
12420
|
-
"description": "If `performed?` is `false`, then an [EmptyDrop](/api/liquid/basics#emptydrop) is returned.",
|
12942
|
+
"description": "If `performed?` is `false`, then an [EmptyDrop](/docs/api/liquid/basics#emptydrop) is returned.",
|
12421
12943
|
"examples": [
|
12422
12944
|
|
12423
12945
|
],
|
@@ -12541,6 +13063,12 @@
|
|
12541
13063
|
"description": "",
|
12542
13064
|
"array_value": ""
|
12543
13065
|
},
|
13066
|
+
{
|
13067
|
+
"type": "string",
|
13068
|
+
"name": "captcha",
|
13069
|
+
"description": "",
|
13070
|
+
"array_value": ""
|
13071
|
+
},
|
12544
13072
|
{
|
12545
13073
|
"type": "string",
|
12546
13074
|
"name": "cart",
|
@@ -12991,7 +13519,7 @@
|
|
12991
13519
|
"array_value": ""
|
12992
13520
|
}
|
12993
13521
|
],
|
12994
|
-
"summary": "The [account page](https://help.shopify.com/manual/customers/customer-accounts) URL.",
|
13522
|
+
"summary": "The [account page](https://help.shopify.com/manual/customers/customer-accounts) URL. Redirects to [new customer accounts](https://help.shopify.com/en/manual/customers/customer-accounts/new-customer-accounts) when enabled.",
|
12995
13523
|
"name": "account_url"
|
12996
13524
|
},
|
12997
13525
|
{
|
@@ -13009,7 +13537,7 @@
|
|
13009
13537
|
"array_value": ""
|
13010
13538
|
}
|
13011
13539
|
],
|
13012
|
-
"summary": "The [account login page](/themes/architecture/templates/customers-login) URL.",
|
13540
|
+
"summary": "The [account login page](/themes/architecture/templates/customers-login) URL. Redirects to [new customer accounts](https://help.shopify.com/en/manual/customers/customer-accounts/new-customer-accounts) when enabled.",
|
13013
13541
|
"name": "account_login_url"
|
13014
13542
|
},
|
13015
13543
|
{
|
@@ -13027,7 +13555,7 @@
|
|
13027
13555
|
"array_value": ""
|
13028
13556
|
}
|
13029
13557
|
],
|
13030
|
-
"summary": "The URL to log a customer out of their account.",
|
13558
|
+
"summary": "The URL to log a customer out of their account. Redirects to [new customer accounts](https://help.shopify.com/en/manual/customers/customer-accounts/new-customer-accounts) when enabled.",
|
13031
13559
|
"name": "account_logout_url"
|
13032
13560
|
},
|
13033
13561
|
{
|
@@ -13045,7 +13573,7 @@
|
|
13045
13573
|
"array_value": ""
|
13046
13574
|
}
|
13047
13575
|
],
|
13048
|
-
"summary": "The [password recovery page](/themes/architecture/templates/customers-reset-password) URL.",
|
13576
|
+
"summary": "The [password recovery page](/themes/architecture/templates/customers-reset-password) URL. Redirects to [new customer accounts](https://help.shopify.com/en/manual/customers/customer-accounts/new-customer-accounts) when enabled.",
|
13049
13577
|
"name": "account_recover_url"
|
13050
13578
|
},
|
13051
13579
|
{
|
@@ -13081,7 +13609,7 @@
|
|
13081
13609
|
"array_value": ""
|
13082
13610
|
}
|
13083
13611
|
],
|
13084
|
-
"summary": "The [account addresses page](/themes/architecture/templates/customers-addresses) URL.",
|
13612
|
+
"summary": "The [account addresses page](/themes/architecture/templates/customers-addresses) URL. Redirects to [new customer accounts](https://help.shopify.com/en/manual/customers/customer-accounts/new-customer-accounts) when enabled.",
|
13085
13613
|
"name": "account_addresses_url"
|
13086
13614
|
},
|
13087
13615
|
{
|
@@ -13364,7 +13892,7 @@
|
|
13364
13892
|
{
|
13365
13893
|
"deprecated": false,
|
13366
13894
|
"deprecation_reason": "",
|
13367
|
-
"description": "> Tip:\n> Use the [`highlight` filter](/api/liquid/filters/highlight) to highlight the search terms in search result content.",
|
13895
|
+
"description": "> Tip:\n> Use the [`highlight` filter](/docs/api/liquid/filters/highlight) to highlight the search terms in search result content.",
|
13368
13896
|
"examples": [
|
13369
13897
|
|
13370
13898
|
],
|
@@ -13418,7 +13946,7 @@
|
|
13418
13946
|
{
|
13419
13947
|
"deprecated": false,
|
13420
13948
|
"deprecation_reason": "",
|
13421
|
-
"description": "An item can be an [`article`](/api/liquid/objects/article), a [`page`](/api/liquid/objects/page), or a\n[`product`](/api/liquid/objects/product).\n\n> Tip:\n> Use the [paginate](/api/liquid/tags/paginate) tag to choose how many results to show per page, up to a limit of 50.",
|
13949
|
+
"description": "An item can be an [`article`](/docs/api/liquid/objects/article), a [`page`](/docs/api/liquid/objects/page), or a\n[`product`](/docs/api/liquid/objects/product).\n\n> Tip:\n> Use the [paginate](/docs/api/liquid/tags/paginate) tag to choose how many results to show per page, up to a limit of 50.",
|
13422
13950
|
"examples": [
|
13423
13951
|
{
|
13424
13952
|
"name": "Search result `object_type`",
|
@@ -13521,7 +14049,7 @@
|
|
13521
14049
|
{
|
13522
14050
|
"deprecated": false,
|
13523
14051
|
"deprecation_reason": "",
|
13524
|
-
"description": "A search can be performed on the following object types:\n\n- [`article`](/api/liquid/objects/article)\n- [`page`](/api/liquid/objects/page)\n- [`product`](/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the `types` URL parameter.",
|
14052
|
+
"description": "A search can be performed on the following object types:\n\n- [`article`](/docs/api/liquid/objects/article)\n- [`page`](/docs/api/liquid/objects/page)\n- [`product`](/docs/api/liquid/objects/product)\n\n> Note:\n> The types are determined by the `types` URL parameter.",
|
13525
14053
|
"examples": [
|
13526
14054
|
|
13527
14055
|
],
|
@@ -13670,7 +14198,7 @@
|
|
13670
14198
|
{
|
13671
14199
|
"deprecated": false,
|
13672
14200
|
"deprecation_reason": "",
|
13673
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14201
|
+
"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.",
|
13674
14202
|
"examples": [
|
13675
14203
|
|
13676
14204
|
],
|
@@ -13688,7 +14216,7 @@
|
|
13688
14216
|
{
|
13689
14217
|
"deprecated": false,
|
13690
14218
|
"deprecation_reason": "",
|
13691
|
-
"description": "The value of the **compare at** price is the line item's price without the selling plan applied. If the price and compare\nat price are equal, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14219
|
+
"description": "The value of the **compare at** price is the line item's price without the selling plan applied. If the price and compare\nat price are equal, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
13692
14220
|
"examples": [
|
13693
14221
|
|
13694
14222
|
],
|
@@ -13706,7 +14234,7 @@
|
|
13706
14234
|
{
|
13707
14235
|
"deprecated": false,
|
13708
14236
|
"deprecation_reason": "",
|
13709
|
-
"description": "The maximum length of the array is two. If the associated selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_allocation_price_adjustment` maps to a [`selling_plan_price_adjustment`](/api/liquid/objects/selling_plan_price_adjustment)\nin the [`selling_plan.price_adjustments` array](/api/liquid/objects/selling_plan#selling_plan-price_adjustments). The\n`selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` array contains the resulting money amounts.",
|
14237
|
+
"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.",
|
13710
14238
|
"examples": [
|
13711
14239
|
|
13712
14240
|
],
|
@@ -13724,7 +14252,7 @@
|
|
13724
14252
|
{
|
13725
14253
|
"deprecated": false,
|
13726
14254
|
"deprecation_reason": "",
|
13727
|
-
"description": "If the variant doesn't have a unit price, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14255
|
+
"description": "If the variant doesn't have a unit price, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
13728
14256
|
"examples": [
|
13729
14257
|
|
13730
14258
|
],
|
@@ -13736,13 +14264,13 @@
|
|
13736
14264
|
"array_value": ""
|
13737
14265
|
}
|
13738
14266
|
],
|
13739
|
-
"summary": "The [unit price](/api/liquid/objects/variant#variant-unit_price) of the variant associated with the selling plan, in the currency's subunit.",
|
14267
|
+
"summary": "The [unit price](/docs/api/liquid/objects/variant#variant-unit_price) of the variant associated with the selling plan, in the currency's subunit.",
|
13740
14268
|
"name": "unit_price"
|
13741
14269
|
},
|
13742
14270
|
{
|
13743
14271
|
"deprecated": false,
|
13744
14272
|
"deprecation_reason": "",
|
13745
|
-
"description": "If a selling plan includes multiple deliveries, then the `per_delivery_price` is the `price` divided by the number of\ndeliveries.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14273
|
+
"description": "If a selling plan includes multiple deliveries, then the `per_delivery_price` is the `price` divided by the number of\ndeliveries.\n\nThe value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
13746
14274
|
"examples": [
|
13747
14275
|
|
13748
14276
|
],
|
@@ -13790,13 +14318,13 @@
|
|
13790
14318
|
"array_value": ""
|
13791
14319
|
}
|
13792
14320
|
],
|
13793
|
-
"summary": "The ID of the [`selling_plan_group`](/api/liquid/objects/selling_plan_group) that the selling plan of the allocation belongs to.",
|
14321
|
+
"summary": "The ID of the [`selling_plan_group`](/docs/api/liquid/objects/selling_plan_group) that the selling plan of the allocation belongs to.",
|
13794
14322
|
"name": "selling_plan_group_id"
|
13795
14323
|
},
|
13796
14324
|
{
|
13797
14325
|
"deprecated": false,
|
13798
14326
|
"deprecation_reason": "",
|
13799
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14327
|
+
"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.",
|
13800
14328
|
"examples": [
|
13801
14329
|
|
13802
14330
|
],
|
@@ -13814,7 +14342,7 @@
|
|
13814
14342
|
{
|
13815
14343
|
"deprecated": false,
|
13816
14344
|
"deprecation_reason": "",
|
13817
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14345
|
+
"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.",
|
13818
14346
|
"examples": [
|
13819
14347
|
|
13820
14348
|
],
|
@@ -13876,13 +14404,13 @@
|
|
13876
14404
|
"array_value": ""
|
13877
14405
|
}
|
13878
14406
|
],
|
13879
|
-
"summary": "The 1-based index of the price adjustment in the\n[`selling_plan_allocation.price_adjustments` array](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).",
|
14407
|
+
"summary": "The 1-based index of the price adjustment in the\n[`selling_plan_allocation.price_adjustments` array](/docs/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).",
|
13880
14408
|
"name": "position"
|
13881
14409
|
},
|
13882
14410
|
{
|
13883
14411
|
"deprecated": false,
|
13884
14412
|
"deprecation_reason": "",
|
13885
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14413
|
+
"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.",
|
13886
14414
|
"examples": [
|
13887
14415
|
|
13888
14416
|
],
|
@@ -13898,7 +14426,7 @@
|
|
13898
14426
|
"name": "price"
|
13899
14427
|
}
|
13900
14428
|
],
|
13901
|
-
"summary": "The resulting price from the intent of the associated [`selling_plan_price_adjustment`](/api/liquid/objects/selling_plan_price_adjustment).",
|
14429
|
+
"summary": "The resulting price from the intent of the associated [`selling_plan_price_adjustment`](/docs/api/liquid/objects/selling_plan_price_adjustment).",
|
13902
14430
|
"name": "selling_plan_allocation_price_adjustment",
|
13903
14431
|
"examples": [
|
13904
14432
|
|
@@ -13964,7 +14492,7 @@
|
|
13964
14492
|
{
|
13965
14493
|
"deprecated": false,
|
13966
14494
|
"deprecation_reason": "",
|
13967
|
-
"description": "How this value is interpreted depends on the [value type](/api/liquid/objects/selling_plan_checkout_charge#selling_plan_checkout_charge-value_type) of\nthe checkout charge. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `percentage` | The percent amount of the original price that the customer needs to pay.<br><br>For example, if the value is 50, then the customer needs to pay 50% of the original price. |\n| `price` | The amount that the customer needs to pay in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
14495
|
+
"description": "How this value is interpreted depends on the [value type](/docs/api/liquid/objects/selling_plan_checkout_charge#selling_plan_checkout_charge-value_type) of\nthe checkout charge. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `percentage` | The percent amount of the original price that the customer needs to pay.<br><br>For example, if the value is 50, then the customer needs to pay 50% of the original price. |\n| `price` | The amount that the customer needs to pay in the currency's subunit. |\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
|
13968
14496
|
"examples": [
|
13969
14497
|
|
13970
14498
|
],
|
@@ -14092,7 +14620,7 @@
|
|
14092
14620
|
"array_value": ""
|
14093
14621
|
}
|
14094
14622
|
],
|
14095
|
-
"summary": "The ID of the [`selling_plan_group`](/api/liquid/objects/selling_plan_group) that the selling plan belongs to.",
|
14623
|
+
"summary": "The ID of the [`selling_plan_group`](/docs/api/liquid/objects/selling_plan_group) that the selling plan belongs to.",
|
14096
14624
|
"name": "group_id"
|
14097
14625
|
},
|
14098
14626
|
{
|
@@ -14134,7 +14662,7 @@
|
|
14134
14662
|
{
|
14135
14663
|
"deprecated": false,
|
14136
14664
|
"deprecation_reason": "",
|
14137
|
-
"description": "The maximum length of the array is two. If the selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_price_adjustment` maps to a [`selling_plan_allocation_price_adjustment`](/api/liquid/objects/selling_plan_allocation_price_adjustment)\nin the [`selling_plan_allocation.price_adjustments` array](/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).\nThe `selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` contains the resulting money amounts.",
|
14665
|
+
"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.",
|
14138
14666
|
"examples": [
|
14139
14667
|
|
14140
14668
|
],
|
@@ -14215,7 +14743,7 @@
|
|
14215
14743
|
},
|
14216
14744
|
"deprecated": false,
|
14217
14745
|
"deprecation_reason": "",
|
14218
|
-
"description": "Selling plans are grouped based on shared [selling plan option names](/api/liquid/objects/selling_plan_option#selling_plan_option-name).\n\nTo learn about how to support selling plans in your theme, refer to [Purchase options](/themes/pricing-payments/purchase-options).",
|
14746
|
+
"description": "Selling plans are grouped based on shared [selling plan option names](/docs/api/liquid/objects/selling_plan_option#selling_plan_option-name).\n\nTo learn about how to support selling plans in your theme, refer to [Purchase options](/themes/pricing-payments/purchase-options).",
|
14219
14747
|
"properties": [
|
14220
14748
|
{
|
14221
14749
|
"deprecated": false,
|
@@ -14274,7 +14802,7 @@
|
|
14274
14802
|
{
|
14275
14803
|
"deprecated": false,
|
14276
14804
|
"deprecation_reason": "",
|
14277
|
-
"description": "If the app doesn't provide a value, then `nil` is returned.\n\n> Tip:\n> You can use this property, with the [`where` filter](/api/liquid/filters/where), to filter the\n> [`product.selling_plan_groups` array](/api/liquid/objects/product#product-selling_plan_groups) for all selling plan groups\n> from a specific app.",
|
14805
|
+
"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.",
|
14278
14806
|
"examples": [
|
14279
14807
|
|
14280
14808
|
],
|
@@ -14390,7 +14918,7 @@
|
|
14390
14918
|
"array_value": ""
|
14391
14919
|
}
|
14392
14920
|
],
|
14393
|
-
"summary": "The 1-based index of the option in the [`selling_plan_group.options` array](/api/liquid/objects/selling_plan_group#selling_plan_group-options).",
|
14921
|
+
"summary": "The 1-based index of the option in the [`selling_plan_group.options` array](/docs/api/liquid/objects/selling_plan_group#selling_plan_group-options).",
|
14394
14922
|
"name": "position"
|
14395
14923
|
},
|
14396
14924
|
{
|
@@ -14430,7 +14958,7 @@
|
|
14430
14958
|
"name": "selected_value"
|
14431
14959
|
}
|
14432
14960
|
],
|
14433
|
-
"summary": "Information about a specific option in a [selling plan group](/api/liquid/objects/selling_plan_group).",
|
14961
|
+
"summary": "Information about a specific option in a [selling plan group](/docs/api/liquid/objects/selling_plan_group).",
|
14434
14962
|
"name": "selling_plan_group_option",
|
14435
14963
|
"examples": [
|
14436
14964
|
|
@@ -14494,13 +15022,13 @@
|
|
14494
15022
|
"array_value": ""
|
14495
15023
|
}
|
14496
15024
|
],
|
14497
|
-
"summary": "The 1-based index of the selling plan option in the associated [`selling_plan_group.options` array](/api/liquid/objects/selling_plan_group#selling_plan_group-options).",
|
15025
|
+
"summary": "The 1-based index of the selling plan option in the associated [`selling_plan_group.options` array](/docs/api/liquid/objects/selling_plan_group#selling_plan_group-options).",
|
14498
15026
|
"name": "position"
|
14499
15027
|
},
|
14500
15028
|
{
|
14501
15029
|
"deprecated": false,
|
14502
15030
|
"deprecation_reason": "",
|
14503
|
-
"description": "The value is one of the [`selling_plan_group_option.values`](/api/liquid/objects/selling_plan_group_option#selling_plan_group_option-values).",
|
15031
|
+
"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).",
|
14504
15032
|
"examples": [
|
14505
15033
|
|
14506
15034
|
],
|
@@ -14516,7 +15044,7 @@
|
|
14516
15044
|
"name": "value"
|
14517
15045
|
}
|
14518
15046
|
],
|
14519
|
-
"summary": "Information about a selling plan's value for a specific [`selling_plan_group_option`](/api/liquid/objects/selling_plan_group_option).",
|
15047
|
+
"summary": "Information about a selling plan's value for a specific [`selling_plan_group_option`](/docs/api/liquid/objects/selling_plan_group_option).",
|
14520
15048
|
"name": "selling_plan_option",
|
14521
15049
|
"examples": [
|
14522
15050
|
|
@@ -14554,7 +15082,7 @@
|
|
14554
15082
|
{
|
14555
15083
|
"deprecated": false,
|
14556
15084
|
"deprecation_reason": "",
|
14557
|
-
"description": "In most contexts, the shipping method title appears in the customer's preferred language. However, in the context of an\n[order](/api/liquid/objects/order), the shipping method title appears in the language that the customer checked out in.",
|
15085
|
+
"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.",
|
14558
15086
|
"examples": [
|
14559
15087
|
|
14560
15088
|
],
|
@@ -14572,7 +15100,7 @@
|
|
14572
15100
|
{
|
14573
15101
|
"deprecated": false,
|
14574
15102
|
"deprecation_reason": "",
|
14575
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
15103
|
+
"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.",
|
14576
15104
|
"examples": [
|
14577
15105
|
|
14578
15106
|
],
|
@@ -14590,7 +15118,7 @@
|
|
14590
15118
|
{
|
14591
15119
|
"deprecated": false,
|
14592
15120
|
"deprecation_reason": "",
|
14593
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
15121
|
+
"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.",
|
14594
15122
|
"examples": [
|
14595
15123
|
|
14596
15124
|
],
|
@@ -14620,7 +15148,7 @@
|
|
14620
15148
|
"array_value": ""
|
14621
15149
|
}
|
14622
15150
|
],
|
14623
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the shipping method.",
|
15151
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the shipping method.",
|
14624
15152
|
"name": "handle"
|
14625
15153
|
},
|
14626
15154
|
{
|
@@ -14763,7 +15291,7 @@
|
|
14763
15291
|
{
|
14764
15292
|
"deprecated": false,
|
14765
15293
|
"deprecation_reason": "",
|
14766
|
-
"description": "> Tip:\n> You can get the store's currency with [`shop.currency`](/api/liquid/objects/shop#shop-currency).",
|
15294
|
+
"description": "> Tip:\n> You can get the store's currency with [`shop.currency`](/docs/api/liquid/objects/shop#shop-currency).",
|
14767
15295
|
"examples": [
|
14768
15296
|
|
14769
15297
|
],
|
@@ -14798,7 +15326,7 @@
|
|
14798
15326
|
},
|
14799
15327
|
{
|
14800
15328
|
"deprecated": true,
|
14801
|
-
"deprecation_reason": "Deprecated because the name didn't make it clear that the returned locales were published.\n\nThe `shop.enabled_locales` property has been replaced by [`shop.published_locales`](/api/liquid/objects/shop#shop-published_locales).",
|
15329
|
+
"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).",
|
14802
15330
|
"description": "",
|
14803
15331
|
"examples": [
|
14804
15332
|
|
@@ -14822,7 +15350,7 @@
|
|
14822
15350
|
},
|
14823
15351
|
{
|
14824
15352
|
"deprecated": true,
|
14825
|
-
"deprecation_reason": "Deprecated because this value is contextual to the request and not a property of the shop resource.\n\nThe `shop.locale` property has been replaced by [request.locale](/api/liquid/objects/request#request-locale).",
|
15353
|
+
"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).",
|
14826
15354
|
"description": "",
|
14827
15355
|
"examples": [
|
14828
15356
|
|
@@ -15082,13 +15610,13 @@
|
|
15082
15610
|
"return_type": [
|
15083
15611
|
|
15084
15612
|
],
|
15085
|
-
"summary": "The [metafields](/api/liquid/objects/metafield) applied to the store.",
|
15613
|
+
"summary": "The [metafields](/docs/api/liquid/objects/metafield) applied to the store.",
|
15086
15614
|
"name": "metafields"
|
15087
15615
|
},
|
15088
15616
|
{
|
15089
15617
|
"deprecated": false,
|
15090
15618
|
"deprecation_reason": "",
|
15091
|
-
"description": "The payment types are based on the store's enabled [payment providers](https://help.shopify.com/manual/payments) and\nthe customer's current region and currency.\n\n> Tip:\n> You can output an `svg` logo for each payment type with the [`payment_type_svg_tag` filter](/api/liquid/filters/payment_type_svg_tag).\n> Alternatively, you can get the source URL for each `svg` with the [`payment_type_img_url` filter](/api/liquid/filters/payment_type_img_url).",
|
15619
|
+
"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).",
|
15092
15620
|
"examples": [
|
15093
15621
|
|
15094
15622
|
],
|
@@ -15105,7 +15633,7 @@
|
|
15105
15633
|
},
|
15106
15634
|
{
|
15107
15635
|
"deprecated": true,
|
15108
|
-
"deprecation_reason": "Deprecated because whether or not prices have taxes included is dependent on the customer's country.\n\nThe `shop.taxes_included` property has been replaced by [cart.taxes_included](/api/liquid/objects/cart#cart-taxes_included).",
|
15636
|
+
"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).",
|
15109
15637
|
"description": "",
|
15110
15638
|
"examples": [
|
15111
15639
|
|
@@ -15345,6 +15873,19 @@
|
|
15345
15873
|
],
|
15346
15874
|
"summary": "Returns `true` if the store accepts gift cards. Returns `false` if not.",
|
15347
15875
|
"name": "accepts_gift_cards"
|
15876
|
+
},
|
15877
|
+
{
|
15878
|
+
"deprecated": false,
|
15879
|
+
"deprecation_reason": "",
|
15880
|
+
"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.",
|
15881
|
+
"examples": [
|
15882
|
+
|
15883
|
+
],
|
15884
|
+
"return_type": [
|
15885
|
+
|
15886
|
+
],
|
15887
|
+
"summary": "All of the [metaobjects](/docs/api/liquid/objects/metaobject) of the store.",
|
15888
|
+
"name": "metaobjects"
|
15348
15889
|
}
|
15349
15890
|
],
|
15350
15891
|
"summary": "Information about the store, such as the store address, the total number of products, and various settings.",
|
@@ -15769,7 +16310,7 @@
|
|
15769
16310
|
{
|
15770
16311
|
"deprecated": false,
|
15771
16312
|
"deprecation_reason": "",
|
15772
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted price.",
|
16313
|
+
"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.",
|
15773
16314
|
"examples": [
|
15774
16315
|
|
15775
16316
|
],
|
@@ -15846,7 +16387,7 @@
|
|
15846
16387
|
]
|
15847
16388
|
},
|
15848
16389
|
"deprecated": true,
|
15849
|
-
"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
|
16390
|
+
"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).",
|
15850
16391
|
"description": "",
|
15851
16392
|
"properties": [
|
15852
16393
|
{
|
@@ -16262,7 +16803,7 @@
|
|
16262
16803
|
{
|
16263
16804
|
"deprecated": false,
|
16264
16805
|
"deprecation_reason": "",
|
16265
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
16806
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
16266
16807
|
"examples": [
|
16267
16808
|
|
16268
16809
|
],
|
@@ -16352,7 +16893,7 @@
|
|
16352
16893
|
"array_value": ""
|
16353
16894
|
}
|
16354
16895
|
],
|
16355
|
-
"summary": "The [handleized](/api/liquid/basics#modifying-handles) name of the payment provider used for the transaction.",
|
16896
|
+
"summary": "The [handleized](/docs/api/liquid/basics#modifying-handles) name of the payment provider used for the transaction.",
|
16356
16897
|
"name": "gateway"
|
16357
16898
|
},
|
16358
16899
|
{
|
@@ -16394,7 +16935,7 @@
|
|
16394
16935
|
{
|
16395
16936
|
"deprecated": false,
|
16396
16937
|
"deprecation_reason": "",
|
16397
|
-
"description": "The amount is in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
16938
|
+
"description": "The amount is in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
|
16398
16939
|
"examples": [
|
16399
16940
|
|
16400
16941
|
],
|
@@ -16580,7 +17121,7 @@
|
|
16580
17121
|
"array_value": ""
|
16581
17122
|
}
|
16582
17123
|
],
|
16583
|
-
"summary": "The unit of measurement used to measure the [`quantity_value`](/api/liquid/objects/unit_price_measurement#unit_price_measurement-quantity_value).",
|
17124
|
+
"summary": "The unit of measurement used to measure the [`quantity_value`](/docs/api/liquid/objects/unit_price_measurement#unit_price_measurement-quantity_value).",
|
16584
17125
|
"name": "quantity_unit"
|
16585
17126
|
},
|
16586
17127
|
{
|
@@ -16616,7 +17157,7 @@
|
|
16616
17157
|
"array_value": ""
|
16617
17158
|
}
|
16618
17159
|
],
|
16619
|
-
"summary": "The unit of measurement used to measure the [`reference_value`](/api/liquid/objects/unit_price_measurement#unit_price_measurement-reference_value).",
|
17160
|
+
"summary": "The unit of measurement used to measure the [`reference_value`](/docs/api/liquid/objects/unit_price_measurement#unit_price_measurement-reference_value).",
|
16620
17161
|
"name": "reference_unit"
|
16621
17162
|
}
|
16622
17163
|
],
|
@@ -16829,7 +17370,7 @@
|
|
16829
17370
|
},
|
16830
17371
|
"deprecated": false,
|
16831
17372
|
"deprecation_reason": "",
|
16832
|
-
"description": "> Tip:\n> Use the [`video_tag` filter](/api/liquid/filters/video_tag) to output the video in an HTML `<video>` tag.",
|
17373
|
+
"description": "> Tip:\n> Use the [`video_tag` filter](/docs/api/liquid/filters/video_tag) to output the video in an HTML `<video>` tag.",
|
16833
17374
|
"properties": [
|
16834
17375
|
{
|
16835
17376
|
"deprecated": false,
|
@@ -16928,7 +17469,7 @@
|
|
16928
17469
|
"examples": [
|
16929
17470
|
{
|
16930
17471
|
"name": "Filter for media of a specific type",
|
16931
|
-
"description": "You can use the `media_type` property with the [`where` filter](/api/liquid/filters/where) to filter the [`product.media` array](/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
17472
|
+
"description": "You can use the `media_type` property with the [`where` filter](/docs/api/liquid/filters/where) to filter the [`product.media` array](/docs/api/liquid/objects/product#product-media) for all media of a desired type.\n",
|
16932
17473
|
"syntax": "",
|
16933
17474
|
"path": "/products/potion-beats",
|
16934
17475
|
"raw_liquid": "{% assign videos = product.media | where: 'media_type', 'video' %}\n\n{% for video in videos %}\n {{- video | video_tag }}\n{% endfor %}",
|
@@ -16963,7 +17504,7 @@
|
|
16963
17504
|
"array_value": ""
|
16964
17505
|
}
|
16965
17506
|
],
|
16966
|
-
"summary": "The position of the video in the [`product.media`](/api/liquid/objects/product#product-media) array.",
|
17507
|
+
"summary": "The position of the video in the [`product.media`](/docs/api/liquid/objects/product#product-media) array.",
|
16967
17508
|
"name": "position"
|
16968
17509
|
},
|
16969
17510
|
{
|
@@ -16985,7 +17526,7 @@
|
|
16985
17526
|
"name": "preview_image"
|
16986
17527
|
}
|
16987
17528
|
],
|
16988
|
-
"summary": "Information about a video uploaded as [product media](/api/liquid/objects/product-media) or a [`file_reference` metafield](/apps/metafields/types).",
|
17529
|
+
"summary": "Information about a video uploaded as [product media](/docs/api/liquid/objects/product-media) or a [`file_reference` metafield](/apps/metafields/types).",
|
16989
17530
|
"name": "video",
|
16990
17531
|
"examples": [
|
16991
17532
|
|
@@ -17091,7 +17632,7 @@
|
|
17091
17632
|
],
|
17092
17633
|
"return_type": [
|
17093
17634
|
{
|
17094
|
-
"type": "
|
17635
|
+
"type": "string",
|
17095
17636
|
"name": "",
|
17096
17637
|
"description": "",
|
17097
17638
|
"array_value": ""
|
@@ -17145,7 +17686,7 @@
|
|
17145
17686
|
},
|
17146
17687
|
"deprecated": false,
|
17147
17688
|
"deprecation_reason": "",
|
17148
|
-
"description": "Use `additional_checkout_buttons` to check whether these payment providers exist, and\n[`content_for_additional_checkout_buttons`](/api/liquid/objects/content_for_additional_checkout_buttons)\nto show the associated checkout buttons. To learn more about how to use these objects, refer to\n[Accelerated checkout](/themes/pricing-payments/accelerated-checkout).\n\n```liquid\n{% if additional_checkout_buttons %}\n {{ content_for_additional_checkout_buttons }}\n{% endif %}\n```",
|
17689
|
+
"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```",
|
17149
17690
|
"properties": [
|
17150
17691
|
|
17151
17692
|
],
|
@@ -17180,7 +17721,7 @@
|
|
17180
17721
|
},
|
17181
17722
|
"deprecated": false,
|
17182
17723
|
"deprecation_reason": "",
|
17183
|
-
"description": "An attribute called `data-provinces` is set for each `<option>`, and contains a JSON-encoded array of the\ncountry or region's subregions. If a country doesn't have any subregions, then an empty array is set for\nits `data-provinces` attribute.\n\n> Tip:\n> To return only the countries and regions included in the store's shipping zones, use the [`country_option_tags` object](/api/liquid/objects/country_option_tags).",
|
17724
|
+
"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).",
|
17184
17725
|
"properties": [
|
17185
17726
|
|
17186
17727
|
],
|
@@ -17259,7 +17800,7 @@
|
|
17259
17800
|
},
|
17260
17801
|
"deprecated": false,
|
17261
17802
|
"deprecation_reason": "",
|
17262
|
-
"description": "
|
17803
|
+
"description": "> Deprecated:\n> <p>The <code>checkout</code> object will be deprecated for the Information, Shipping, and Payment pages on August 13, 2024. Merchants who have customized these pages using <code>checkout.liquid</code> to <a href=\"https://help.shopify.com/manual/online-store/themes/theme-structure/extend/checkout-migration#migrate-to-checkout-extensibility\">upgrade to checkout extensibility</a> before August 13, 2024.</p>\n> <p>Learn <a href=\"/apps/checkout\">how to build checkout extensions</a> that extend the functionality of Shopify checkout.</p>\n\nYou can access the `checkout` object on the [order status page](https://help.shopify.com/manual/orders/status-tracking/customize-order-status).\n\nShopify Plus merchants can access the `checkout` object in the [`checkout.liquid` layout](/themes/architecture/layouts/checkout-liquid).",
|
17263
17804
|
"properties": [
|
17264
17805
|
{
|
17265
17806
|
"deprecated": false,
|
@@ -17282,7 +17823,7 @@
|
|
17282
17823
|
{
|
17283
17824
|
"deprecated": false,
|
17284
17825
|
"deprecation_reason": "",
|
17285
|
-
"description": "
|
17826
|
+
"description": "Shopify Plus merchants that have access to `checkout.liquid` can [capture attributes at checkout](/themes/architecture/layouts/checkout-liquid#capture-checkout-attributes).",
|
17286
17827
|
"examples": [
|
17287
17828
|
|
17288
17829
|
],
|
@@ -17294,7 +17835,7 @@
|
|
17294
17835
|
"array_value": ""
|
17295
17836
|
}
|
17296
17837
|
],
|
17297
|
-
"summary": "Additional attributes entered by the customer with the [cart](/api/liquid/objects/cart#cart-attributes).",
|
17838
|
+
"summary": "Additional attributes entered by the customer with the [cart](/docs/api/liquid/objects/cart#cart-attributes).",
|
17298
17839
|
"name": "attributes"
|
17299
17840
|
},
|
17300
17841
|
{
|
@@ -17425,7 +17966,7 @@
|
|
17425
17966
|
},
|
17426
17967
|
{
|
17427
17968
|
"deprecated": true,
|
17428
|
-
"deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `checkout.discounts` property has been replaced by [`checkout.discount_applications`](/api/liquid/objects/checkout#checkout-discount_applications).",
|
17969
|
+
"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).",
|
17429
17970
|
"description": "",
|
17430
17971
|
"examples": [
|
17431
17972
|
|
@@ -17462,7 +18003,7 @@
|
|
17462
18003
|
{
|
17463
18004
|
"deprecated": false,
|
17464
18005
|
"deprecation_reason": "",
|
17465
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
18006
|
+
"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.",
|
17466
18007
|
"examples": [
|
17467
18008
|
|
17468
18009
|
],
|
@@ -17480,7 +18021,7 @@
|
|
17480
18021
|
{
|
17481
18022
|
"deprecated": false,
|
17482
18023
|
"deprecation_reason": "",
|
17483
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
18024
|
+
"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.",
|
17484
18025
|
"examples": [
|
17485
18026
|
|
17486
18027
|
],
|
@@ -17588,7 +18129,7 @@
|
|
17588
18129
|
{
|
17589
18130
|
"deprecated": false,
|
17590
18131
|
"deprecation_reason": "",
|
17591
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
18132
|
+
"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.",
|
17592
18133
|
"examples": [
|
17593
18134
|
|
17594
18135
|
],
|
@@ -17642,7 +18183,7 @@
|
|
17642
18183
|
{
|
17643
18184
|
"deprecated": false,
|
17644
18185
|
"deprecation_reason": "",
|
17645
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
18186
|
+
"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.",
|
17646
18187
|
"examples": [
|
17647
18188
|
|
17648
18189
|
],
|
@@ -17660,7 +18201,7 @@
|
|
17660
18201
|
{
|
17661
18202
|
"deprecated": false,
|
17662
18203
|
"deprecation_reason": "",
|
17663
|
-
"description": "This value is the same as [`checkout.id`](/api/liquid/objects/checkout#checkout-id) with a `#` prepended to it.",
|
18204
|
+
"description": "This value is the same as [`checkout.id`](/docs/api/liquid/objects/checkout#checkout-id) with a `#` prepended to it.",
|
17664
18205
|
"examples": [
|
17665
18206
|
|
17666
18207
|
],
|
@@ -17690,7 +18231,7 @@
|
|
17690
18231
|
"array_value": ""
|
17691
18232
|
}
|
17692
18233
|
],
|
17693
|
-
"summary": "Additional information entered by the customer with the [cart](/api/liquid/objects/cart#cart-note).",
|
18234
|
+
"summary": "Additional information entered by the customer with the [cart](/docs/api/liquid/objects/cart#cart-note).",
|
17694
18235
|
"name": "note"
|
17695
18236
|
},
|
17696
18237
|
{
|
@@ -17714,7 +18255,7 @@
|
|
17714
18255
|
{
|
17715
18256
|
"deprecated": false,
|
17716
18257
|
"deprecation_reason": "",
|
17717
|
-
"description": "The value is the same as [`order.id`](/api/liquid/objects/order#order-id).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.",
|
18258
|
+
"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.",
|
17718
18259
|
"examples": [
|
17719
18260
|
|
17720
18261
|
],
|
@@ -17732,7 +18273,7 @@
|
|
17732
18273
|
{
|
17733
18274
|
"deprecated": false,
|
17734
18275
|
"deprecation_reason": "",
|
17735
|
-
"description": "The value is the same as [`order.name`](/api/liquid/objects/order#order-name).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.",
|
18276
|
+
"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.",
|
17736
18277
|
"examples": [
|
17737
18278
|
|
17738
18279
|
],
|
@@ -17750,7 +18291,7 @@
|
|
17750
18291
|
{
|
17751
18292
|
"deprecated": false,
|
17752
18293
|
"deprecation_reason": "",
|
17753
|
-
"description": "The value is the same as [`order.order_number`](/api/liquid/objects/order#order-order_number).\n\nDepending on the payment provider, the order might not have been created when the [Order status page](https://help.shopify.com/en/manual/orders/status-tracking)\nis first viewed. In this case, `nil` is returned.",
|
18294
|
+
"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.",
|
17754
18295
|
"examples": [
|
17755
18296
|
|
17756
18297
|
],
|
@@ -17822,7 +18363,7 @@
|
|
17822
18363
|
{
|
17823
18364
|
"deprecated": false,
|
17824
18365
|
"deprecation_reason": "",
|
17825
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
18366
|
+
"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.",
|
17826
18367
|
"examples": [
|
17827
18368
|
|
17828
18369
|
],
|
@@ -17858,7 +18399,7 @@
|
|
17858
18399
|
{
|
17859
18400
|
"deprecated": false,
|
17860
18401
|
"deprecation_reason": "",
|
17861
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
18402
|
+
"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.",
|
17862
18403
|
"examples": [
|
17863
18404
|
|
17864
18405
|
],
|
@@ -17876,7 +18417,7 @@
|
|
17876
18417
|
{
|
17877
18418
|
"deprecated": false,
|
17878
18419
|
"deprecation_reason": "",
|
17879
|
-
"description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/api/liquid/filters/money-filters) to output a formatted amount.",
|
18420
|
+
"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.",
|
17880
18421
|
"examples": [
|
17881
18422
|
|
17882
18423
|
],
|
@@ -17929,7 +18470,7 @@
|
|
17929
18470
|
},
|
17930
18471
|
{
|
17931
18472
|
"deprecated": true,
|
17932
|
-
"deprecation_reason": "Deprecated because the array is always the same as [`checkout.line_items`](/api/liquid/objects/checkout#checkout-line_items).",
|
18473
|
+
"deprecation_reason": "Deprecated because the array is always the same as [`checkout.line_items`](/docs/api/liquid/objects/checkout#checkout-line_items).",
|
17933
18474
|
"description": "",
|
17934
18475
|
"examples": [
|
17935
18476
|
|
@@ -18016,7 +18557,7 @@
|
|
18016
18557
|
{
|
18017
18558
|
"deprecated": false,
|
18018
18559
|
"deprecation_reason": "",
|
18019
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
18560
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
18020
18561
|
"examples": [
|
18021
18562
|
|
18022
18563
|
],
|
@@ -18070,7 +18611,7 @@
|
|
18070
18611
|
{
|
18071
18612
|
"deprecated": false,
|
18072
18613
|
"deprecation_reason": "",
|
18073
|
-
"description": "Outside of the Liquid context, the status of a comment can vary based on spam detection and whether blog comments are\nmoderated. However, only comments with a status of `published` are included in the [`article.comments` array](/api/liquid/objects/article#article-comments).\n\n> Tip:\n> To learn more about blog comments, visit the [Shopify Help Center](https://help.shopify.com/manual/online-store/blogs/managing-comments).",
|
18614
|
+
"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).",
|
18074
18615
|
"examples": [
|
18075
18616
|
|
18076
18617
|
],
|
@@ -18088,7 +18629,7 @@
|
|
18088
18629
|
{
|
18089
18630
|
"deprecated": false,
|
18090
18631
|
"deprecation_reason": "",
|
18091
|
-
"description": "> Tip:\n> Use the [`date` filter](/api/liquid/filters/date) to format the timestamp.",
|
18632
|
+
"description": "> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
|
18092
18633
|
"examples": [
|
18093
18634
|
|
18094
18635
|
],
|
@@ -18118,7 +18659,7 @@
|
|
18118
18659
|
"array_value": ""
|
18119
18660
|
}
|
18120
18661
|
],
|
18121
|
-
"summary": "The relative URL of the article that the comment is associated with, with [`comment.id`](/api/liquid/objects/comment#comment-id)\nappended.",
|
18662
|
+
"summary": "The relative URL of the article that the comment is associated with, with [`comment.id`](/docs/api/liquid/objects/comment#comment-id)\nappended.",
|
18122
18663
|
"name": "url"
|
18123
18664
|
}
|
18124
18665
|
],
|
@@ -18148,7 +18689,7 @@
|
|
18148
18689
|
},
|
18149
18690
|
"deprecated": false,
|
18150
18691
|
"deprecation_reason": "",
|
18151
|
-
"description": "Use [`additional_checkout_buttons`](/api/liquid/objects/additional_checkout_buttons)\nto check whether these payment providers exist, and `content_for_additional_checkout_buttons`\nto show the associated checkout buttons. To learn more about how to use these objects, refer to\n[Accelerated checkout](/themes/pricing-payments/accelerated-checkout).\n\n```liquid\n{% if additional_checkout_buttons %}\n {{ content_for_additional_checkout_buttons }}\n{% endif %}\n```",
|
18692
|
+
"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```",
|
18152
18693
|
"properties": [
|
18153
18694
|
|
18154
18695
|
],
|
@@ -18253,7 +18794,7 @@
|
|
18253
18794
|
},
|
18254
18795
|
"deprecated": false,
|
18255
18796
|
"deprecation_reason": "",
|
18256
|
-
"description": "An attribute called `data-provinces` is set for each `<option>`, and contains a JSON-encoded array of the\ncountry or region's subregions. If a country doesn't have any subregions, then an empty array is set for its\n`data-provinces` attribute.\n\n> Tip:\n> To return all countries and regions included in the store's shipping zones, use [`all_country_option_tags`](/api/liquid/objects/all_country_option_tags).",
|
18797
|
+
"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).",
|
18257
18798
|
"properties": [
|
18258
18799
|
|
18259
18800
|
],
|
@@ -18419,7 +18960,7 @@
|
|
18419
18960
|
"name": "translated_fields"
|
18420
18961
|
}
|
18421
18962
|
],
|
18422
|
-
"summary": "The error category strings for errors from a form created by a [`form` tag](/api/liquid/tags/form).",
|
18963
|
+
"summary": "The error category strings for errors from a form created by a [`form` tag](/docs/api/liquid/tags/form).",
|
18423
18964
|
"name": "form_errors",
|
18424
18965
|
"examples": [
|
18425
18966
|
{
|
@@ -18463,7 +19004,7 @@
|
|
18463
19004
|
"properties": [
|
18464
19005
|
|
18465
19006
|
],
|
18466
|
-
"summary": "The [handle](/api/liquid/basics#handles) of the resource associated with the current template.",
|
19007
|
+
"summary": "The [handle](/docs/api/liquid/basics#handles) of the resource associated with the current template.",
|
18467
19008
|
"name": "handle",
|
18468
19009
|
"examples": [
|
18469
19010
|
|
@@ -18513,7 +19054,13 @@
|
|
18513
19054
|
"type": "string",
|
18514
19055
|
"name": "",
|
18515
19056
|
"description": "",
|
18516
|
-
"array_value": ""
|
19057
|
+
"array_value": "",
|
19058
|
+
"denied_filters": [
|
19059
|
+
"escape",
|
19060
|
+
"escape_once",
|
19061
|
+
"url_escape",
|
19062
|
+
"url_param_escape"
|
19063
|
+
]
|
18517
19064
|
}
|
18518
19065
|
]
|
18519
19066
|
},
|
@@ -18583,7 +19130,13 @@
|
|
18583
19130
|
"type": "string",
|
18584
19131
|
"name": "",
|
18585
19132
|
"description": "",
|
18586
|
-
"array_value": ""
|
19133
|
+
"array_value": "",
|
19134
|
+
"denied_filters": [
|
19135
|
+
"escape",
|
19136
|
+
"escape_once",
|
19137
|
+
"url_escape",
|
19138
|
+
"url_param_escape"
|
19139
|
+
]
|
18587
19140
|
}
|
18588
19141
|
]
|
18589
19142
|
},
|
@@ -18672,7 +19225,7 @@
|
|
18672
19225
|
"examples": [
|
18673
19226
|
{
|
18674
19227
|
"name": "Create pagination navigation with `part`",
|
18675
|
-
"description": "You can create a pagination navigation by iterating over each `part` of a [`paginate` object](/api/liquid/objects/paginate).\n",
|
19228
|
+
"description": "You can create a pagination navigation by iterating over each `part` of a [`paginate` object](/docs/api/liquid/objects/paginate).\n",
|
18676
19229
|
"syntax": "",
|
18677
19230
|
"path": "/collections/all",
|
18678
19231
|
"raw_liquid": "{% paginate collection.products by 5 -%}\n {% for part in paginate.parts -%}\n {% if part.is_link -%}\n {{ part.title | link_to: part.url}}\n {%- else -%}\n <span>{{ part.title }}</span>\n {% endif %}\n {%- endfor %}\n{%- endpaginate %}",
|
@@ -18812,7 +19365,7 @@
|
|
18812
19365
|
},
|
18813
19366
|
"deprecated": false,
|
18814
19367
|
"deprecation_reason": "",
|
18815
|
-
"description": "You can check whether any resources of a specific type were returned using the [`size` filter](/api/liquid/filters/size).\n\n```liquid\n{% if predictive_search.resources.articles.size > 0 %}\n {% for article in predictive_search.resources.articles %}\n {{ article.title }}\n {% endfor %}\n{% endif %}\n```",
|
19368
|
+
"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```",
|
18816
19369
|
"properties": [
|
18817
19370
|
{
|
18818
19371
|
"deprecated": false,
|
@@ -18901,6 +19454,101 @@
|
|
18901
19454
|
|
18902
19455
|
]
|
18903
19456
|
},
|
19457
|
+
{
|
19458
|
+
"access": {
|
19459
|
+
"global": false,
|
19460
|
+
"parents": [
|
19461
|
+
{
|
19462
|
+
"object": "variant",
|
19463
|
+
"property": "quantity_rule"
|
19464
|
+
}
|
19465
|
+
],
|
19466
|
+
"template": [
|
19467
|
+
|
19468
|
+
]
|
19469
|
+
},
|
19470
|
+
"deprecated": false,
|
19471
|
+
"deprecation_reason": "",
|
19472
|
+
"description": "",
|
19473
|
+
"properties": [
|
19474
|
+
{
|
19475
|
+
"deprecated": false,
|
19476
|
+
"deprecation_reason": "",
|
19477
|
+
"description": "",
|
19478
|
+
"examples": [
|
19479
|
+
|
19480
|
+
],
|
19481
|
+
"return_type": [
|
19482
|
+
{
|
19483
|
+
"type": "number",
|
19484
|
+
"name": "",
|
19485
|
+
"description": "",
|
19486
|
+
"array_value": ""
|
19487
|
+
}
|
19488
|
+
],
|
19489
|
+
"summary": "Minimum order quantity (default 1)",
|
19490
|
+
"name": "min"
|
19491
|
+
},
|
19492
|
+
{
|
19493
|
+
"deprecated": false,
|
19494
|
+
"deprecation_reason": "",
|
19495
|
+
"description": "If there is no maximum, then `nil` is returned.",
|
19496
|
+
"examples": [
|
19497
|
+
|
19498
|
+
],
|
19499
|
+
"return_type": [
|
19500
|
+
{
|
19501
|
+
"type": "number",
|
19502
|
+
"name": "",
|
19503
|
+
"description": "",
|
19504
|
+
"array_value": ""
|
19505
|
+
}
|
19506
|
+
],
|
19507
|
+
"summary": "Maximum order quantity",
|
19508
|
+
"name": "max"
|
19509
|
+
},
|
19510
|
+
{
|
19511
|
+
"deprecated": false,
|
19512
|
+
"deprecation_reason": "",
|
19513
|
+
"description": "",
|
19514
|
+
"examples": [
|
19515
|
+
|
19516
|
+
],
|
19517
|
+
"return_type": [
|
19518
|
+
{
|
19519
|
+
"type": "number",
|
19520
|
+
"name": "",
|
19521
|
+
"description": "",
|
19522
|
+
"array_value": ""
|
19523
|
+
}
|
19524
|
+
],
|
19525
|
+
"summary": "Order quantity increment (default 1)",
|
19526
|
+
"name": "increment"
|
19527
|
+
}
|
19528
|
+
],
|
19529
|
+
"summary": "A variant order quantity rule (minimum, maximum, and increment). The default order variant quantity rule is `min=1,max=null,increment=1`.",
|
19530
|
+
"name": "quantity_rule",
|
19531
|
+
"examples": [
|
19532
|
+
{
|
19533
|
+
"name": "The variant order quantity rule",
|
19534
|
+
"description": "",
|
19535
|
+
"syntax": "",
|
19536
|
+
"path": "/products/health-potion",
|
19537
|
+
"raw_liquid": "{{ product.variants.first.quantity_rule }}",
|
19538
|
+
"parameter": false,
|
19539
|
+
"display_type": "text",
|
19540
|
+
"show_data_tab": true
|
19541
|
+
}
|
19542
|
+
],
|
19543
|
+
"json_data": {
|
19544
|
+
"path": "",
|
19545
|
+
"handle": "",
|
19546
|
+
"data_from_file": "{\"min\":\"1\",\"max\":null,\"increment\":\"1\"}"
|
19547
|
+
},
|
19548
|
+
"return_type": [
|
19549
|
+
|
19550
|
+
]
|
19551
|
+
},
|
18904
19552
|
{
|
18905
19553
|
"access": {
|
18906
19554
|
"global": true,
|
@@ -19067,7 +19715,7 @@
|
|
19067
19715
|
{
|
19068
19716
|
"deprecated": false,
|
19069
19717
|
"deprecation_reason": "",
|
19070
|
-
"description": "This value is used when assigning the [`collection.sort_by`](/api/liquid/objects/collection#collection-sort_by) and\n[`search.sort_by`](/api/liquid/objects/search#search-sort_by) parameters.",
|
19718
|
+
"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.",
|
19071
19719
|
"examples": [
|
19072
19720
|
|
19073
19721
|
],
|